DMS RESTful APIs

Prev

The application exposes various RESTful APIs that enables you to manage data efficiently as per the business requirement. To use these APIs, your application must use https to authenticate the request. It is mandatory to only use https for API access, http must not be used. For more information, see Authentication Services.

The request and responses are in JSON format and caters to numerous variations to support most common business scenarios. Because the REST API is based on open standards, you can use any web development language to access the API.

Supported Services

The following services are supported in the DMS application:

Services Description Service Path
Entity App Services Responsible for the providing additional services for all the master data. {TenantURL or ID}/api/entityappservice/
Entity App Model Services Responsible for all the models related to data and governance data. {TenantURL or ID}/api/entityappmodelService/
Services How do I
Entity App Services • Understand Entity in a Context
• Data Type Summary
• Relationship Type Summary
• Entity Object Structure
• Create an Entity
• Set Attribute(s) Value as Do Not Inherit
• Update an Entity
• Delete an Entity
• Process an Entity
• Get Entities
• Scroll Support for Entity App Services
• Get Entity History
• Get Entity History - Context
• Get Entities using Originating Source Information
• Get Related Entities
Entity App Model Services • Data Model Object Structure
• Get Data Model
• Get Composite
Asset Services • Overview of Asset Creation
• Asset Object Structure
• Map Asset Metadata Fields to Attributes
• Ignore processing assets used in Add-on apps
• Get Asset Details using Asset Id
• Get Details of Asset Linked to an Entity
• Create or Update Asset Renditions