Valuekeep Developers - Web API Reference

Framework | Schema Entity Management

Schema Entity Management Service.

Overview


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

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

All Enumerations

This service uses the following enumerations:

GET Operations

GET SchemaEntities (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 SchemaEntityResource.

Response status codes:

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

Resource URL:

GET /corePatterns/schemaEntities/odata

GET SchemaEntity 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 SchemaEntityResource.

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

GET SchemaEntity by key

Returns the entity record that matches the specified key.

The following elements are required:

key (string) Entity Name.
moduleName (string) Module Name.

Response:

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

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/schemaEntities/{key}/{moduleName}

GET Schema Entities OData

Returns the list of all the entity records available.

Response:

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

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/schemaEntities/extensible/odata

POST Operations

POST CustomEntities

Creates a new entity record.

The following elements are required:

schemaEntityResource (ApiCustomEntityResource) The request body should contain the entity record that should be created.
See ApiCustomEntityResource.

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

Response status codes:

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

Resource URL:

POST /corePatterns/schemaEntities

POST Add Entity To Menu

Add entity to menu.

The following elements are required:

menuItems (List) The list of menuItems to add the entity.
entity (string) The entity.

Response:

When successful, the response body is empty.

Resource URL:

POST /corePatterns/schemaEntities/addEntityToMenu/{entity}

PUT Operations

PUT Set AllowExtensibility SchemaEntity

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

The following elements are required:

key (string) Entity Name.
moduleName (string) Module Name.
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.

Resource URL:

PUT /corePatterns/schemaEntities/{key}/{moduleName}/allowExtensibility

PUT Set DescriptionLabel SchemaEntity

Updates the value of 'descriptionlabel' in the specified entity record.

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/schemaEntities/{key}/{moduleName}/descriptionlabel

PUT Set IsActive SchemaEntity

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

The following elements are required:

key (string) Entity Name.
moduleName (string) Module Name.
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/schemaEntities/{key}/{moduleName}/isActive

PUT Set IsCompanyDependent SchemaEntity

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

The following elements are required:

key (string) Entity Name.
moduleName (string) Module Name.
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.

Resource URL:

PUT /corePatterns/schemaEntities/{key}/{moduleName}/isCompanyDependent

PUT Set KeyLabel SchemaEntity

Updates the value of 'keylabel' in the specified entity record.

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/schemaEntities/{key}/{moduleName}/keylabel

PUT Set ModuleName SchemaEntity

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

The following elements are required:

key (string) Entity Name.
moduleName (string) Module Name.
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/schemaEntities/{key}/{moduleName}/moduleName

PUT Set Remarks SchemaEntity

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

The following elements are required:

key (string) Entity Name.
moduleName (string) Module Name.
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/schemaEntities/{key}/{moduleName}/remarks

PUT Set Title SchemaEntity

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

The following elements are required:

key (string) Entity Name.
moduleName (string) Module Name.
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/schemaEntities/{key}/{moduleName}/title

DELETE Operations

DELETE SchemaEntity 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/schemaEntities/{id}

DELETE SchemaEntity by key

Deletes the entity record that matches the specified key.

The following elements are required:

key (string) Entity Name.
moduleName (string) Module Name.

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/schemaEntities/{key}/{moduleName}

Resources


ApiCustomEntityResource

The following elements are required:

key (string) Entity Name.
keyLabel (string) Key Attribute Label.
descriptionLabel (string) Description Attribute Label.
allowExtensibility (bool) Allow Extensibility.
moduleName (string) Module Name.

The following elements are optional:

title (string) Entity Title.
remarks (string) Remarks.
editOperationReport (string) Edit Operation Report.
isCompanyDependent (bool) Is Company Dependent.


CustomEntityResource

The following elements are required:

key (string) Entity Name.
moduleName (string) Module Name.
isExternallyManaged (bool) Is Externally Managed.
allowExtensibility (bool) Allow Extensibility.
keyLabel (string) Key Attribute Label.
descriptionLabel (string) Description Attribute Label.

The following elements are optional:

title (string) Entity Title.
entityType (enum SchemaEntityType) Indicate the entity type.
See SchemaEntityType.
entityName (string) Entity Name.
baseEntityId (Guid) Base Entity Id.
schemaEntityPatterns (List of SchemaEntityPatternResource) Schema Entity Patterns.
See SchemaEntityPatternResource.
associations (List of SchemaEntitiesAssociationResource) Associations.
See SchemaEntitiesAssociationResource.
hasState (bool) If true than can be associated states to the entity.
isGenericExtension (bool) Is Generic Extension.
lockingEnabled (bool) Locking Enabled.
database (string) Database.
hasSequenceAttribute (bool) Has Sequence Attribute.
isRestrictable (bool) Is Restrictable.
jsonSchema (string) Json Schema.
userEntityDefinition (string) User Entity Definition.
remarks (string) Remarks.
isCompanyDependent (bool) Is Company Dependent.
addedToMenu (bool) Added To Menu.
editOperationReport (string) Edit Operation Report.


ExtensibilityMenuItemShortResource

The following elements are optional:

menuId (Guid) Menu Id.


ExtensibilitySchemaEntityResource

The following elements are optional:

opts (ODataQueryOptions) OData query option.


Enumerations


SchemaEntityType

1 System System entity intended for internal reasons.
2 BusinessProcessEvent A single event associated with a business process (ex: a sales entry or a customer order request).
3 BusinessDimension An object involved in a business intelligence effort (ex: customer, item, etc).
4 ValueList Consists of a predefined set of named constants.
5 BusinessNoDatabase
6 UserEntity