Jasmin Developers - Web API Reference

Platform | Extensibility View Definition

Service to manage entities of type 'ExtensibilityViewDefinition'.

Overview


URL api/{tenantKey}/{orgKey}/corePatterns/extensibilityViewDefinitions
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 ExtensibilityViewDefinitions

Returns the list of all the entity records available.

Response:

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

Response status codes:

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

Resource URL:

GET /corePatterns/extensibilityViewDefinitions

GET ExtensibilityViewDefinitions (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 ExtensibilityViewDefinitionResource.

Response status codes:

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

Resource URL:

GET /corePatterns/extensibilityViewDefinitions?page={page}&pageSize={pageSize}

GET ExtensibilityViewDefinition 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 ExtensibilityViewDefinitionResource.

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/extensibilityViewDefinitions/{id}

GET ExtensibilityViewDefinition by key

Returns the entity record that matches the specified key.

The following elements are required:

culture (string) Culture.
schemaEntity (string) Schema Entity.

Response:

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

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/extensibilityViewDefinitions/{culture}/{schemaEntity}

GET Print ExtensibilityViewDefinition 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 /corePatterns/extensibilityViewDefinitions/{id}/print?template={template}

GET Print ExtensibilityViewDefinition by key

Prints the specified entity record.

The following elements are required:

culture (string) Culture.
schemaEntity (string) Schema Entity.

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 /corePatterns/extensibilityViewDefinitions/{culture}/{schemaEntity}/print

GET Original Print ExtensibilityViewDefinitionOriginal 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 /corePatterns/extensibilityViewDefinitions/{id}/printOriginal?template={template}

GET Original Print ExtensibilityViewDefinition by key

Prints the specified entity record.

The following elements are required:

culture (string) Culture.
schemaEntity (string) Schema Entity.

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 /corePatterns/extensibilityViewDefinitions/{culture}/{schemaEntity}/printOriginal

GET Get Extensibility View Definition By Entity And Culture

Custom operation 'GetExtensibilityViewDefinitionByEntityAndCulture'.

The following elements are required:

schemaEntityId (Guid) SchemaEntityId.
culture (string) Culture.

Response:

When successful, the response body contains a resource of type 'ExtensibilityViewDefinitionResource'. See ExtensibilityViewDefinitionResource.

Response status codes:

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

Resource URL:

GET /corePatterns/extensibilityViewDefinitions/getExtensibilityViewDefinitionByEntityAndCulture

POST Operations

POST ExtensibilityViewDefinitions

Creates a new entity record.

The following elements are required:

extensibilityViewDefinitionResource (ApiExtensibilityViewDefinitionResource) The request body should contain the entity record that should be created.
See ApiExtensibilityViewDefinitionResource.

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 ApiExtensibilityViewDefinitionResource.

Response status codes:

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

Resource URL:

POST /corePatterns/extensibilityViewDefinitions

PUT Operations

PUT Set Culture ExtensibilityViewDefinition

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

The following elements are required:

culture (string) Culture.
schemaEntity (string) Schema Entity.
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/extensibilityViewDefinitions/{culture}/{schemaEntity}/culture

PUT Set IsActive ExtensibilityViewDefinition

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

The following elements are required:

culture (string) Culture.
schemaEntity (string) Schema Entity.
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/extensibilityViewDefinitions/{culture}/{schemaEntity}/isActive

PUT Set SchemaEntity ExtensibilityViewDefinition

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

The following elements are required:

culture (string) Culture.
schemaEntity (string) Schema Entity.
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/extensibilityViewDefinitions/{culture}/{schemaEntity}/schemaEntity

PUT Set ViewDefinition ExtensibilityViewDefinition

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

The following elements are required:

culture (string) Culture.
schemaEntity (string) Schema Entity.
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/extensibilityViewDefinitions/{culture}/{schemaEntity}/viewDefinition

DELETE Operations

DELETE ExtensibilityViewDefinition 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/extensibilityViewDefinitions/{id}

DELETE ExtensibilityViewDefinition by key

Deletes the entity record that matches the specified key.

The following elements are required:

culture (string) Culture.
schemaEntity (string) Schema Entity.

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/extensibilityViewDefinitions/{culture}/{schemaEntity}

Resources


ApiExtensibilityViewDefinitionResource

The following elements are required:

culture (string) Culture.
schemaEntity (string) Schema Entity.
viewDefinition (string) View Definition.


ExtensibilityViewDefinitionResource

The following elements are required:

culture (string) Culture.
schemaEntity (string) Schema Entity.
viewDefinition (string) View Definition.