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:

• GET:
  • GET Cultures
  • GET Cultures (paged)
  • GET Culture by identifier
  • GET Culture by key
  • GET Print Culture by identifier
  • GET Print Culture by key
  • GET Original Print CultureOriginal by identifier
  • GET Original Print Culture by key
• POST:
  • POST Cultures
• PUT:
  • PUT Set IsActive Culture
  • PUT Set CultureKey Culture
  • PUT Set Name Culture
• DELETE:
  • DELETE Culture by identifier
  • DELETE Culture by key

All Resources

This service uses the following resources:

• ApiCultureResource
• CultureResource

GET Operations

GET Cultures

Returns the list of all the entity records available.

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 Cultures (paged)

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

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

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 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 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 Print Culture by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Print Culture by key

Prints the specified entity record.

The following elements are required:

cultureKey

(string) The key for the culture.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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 Original Print CultureOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

GET Original Print Culture by key

Prints the specified entity record.

The following elements are required:

cultureKey

(string) The key for the culture.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

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:

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:

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 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 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:

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 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:

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.