Jasmin Developers - Web API Reference

Platform | Culture

Service to manage entities of type 'Culture'.

Overview


URL api/{tenantKey}/{orgKey}/corePatterns/cultures
Methods Supported GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Cultures (odata)

Returns a page of the list of all the entity records available.

The following elements are optional:

opts (ODataQueryOptions) OData query option.

Response:

When successful, the response body contains the list of records available. See CultureResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /corePatterns/cultures/odata

GET Culture by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body contains the entity record. See CultureResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /corePatterns/cultures/{id}

GET Culture by key

Returns the entity record that matches the specified key.

The following elements are required:

cultureKey (string) The key for the culture.

Response:

When successful, the response body contains the entity record. See CultureResource.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

GET /corePatterns/cultures/{cultureKey}

POST Operations

POST Cultures

Creates a new entity record.

The following elements are required:

cultureResource (ApiCultureResource) The request body should contain the entity record that should be created.
See ApiCultureResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiCultureResource.

Response status codes:

201 Created. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

POST /corePatterns/cultures

PUT Operations

PUT Set CultureKey Culture

Updates the value of attribute 'CultureKey' in the specified entity record.

The following elements are required:

cultureKey (string) The key for the culture.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /corePatterns/cultures/{cultureKey}/cultureKey

PUT Set IsActive Culture

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

cultureKey (string) The key for the culture.
value (bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

PUT /corePatterns/cultures/{cultureKey}/isActive

PUT Set Name Culture

Updates the value of attribute 'Name' in the specified entity record.

The following elements are required:

cultureKey (string) The key for the culture.
value (string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

PUT /corePatterns/cultures/{cultureKey}/name

DELETE Operations

DELETE Culture by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id (string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /corePatterns/cultures/{id}

DELETE Culture by key

Deletes the entity record that matches the specified key.

The following elements are required:

cultureKey (string) The key for the culture.

Response:

When successful, the response body is empty.

Response status codes:

204 Deleted. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.
404 NotFound. The specified record does not exist.

Resource URL:

DELETE /corePatterns/cultures/{cultureKey}

Resources


ApiCultureResource

The following elements are required:

cultureKey (string) The key for the culture.
name (string) The culture's name.


CultureResource

The following elements are required:

cultureKey (string) The key for the culture.
name (string) The culture's name.