# Types

# GET Retrieve Type Definitions

# /modelDefinitions/{modelId}/types

# Description

The following filtering properties are available:
- typeId: string
- name: string
- tags: array[string]
- version: string

If version is not specified in the filter, the latest version of the type definition is retrieved. If any version is included in the filter, the version(s) from filter are retrieved

# Parameters

Name	Located in	Description	Required	Schema
modelId	path	model definition ID	Yes	string
filter	query	A boolean expression used to filter the results	No	WhereClause
limit	query	Limit the number of returned values. Defaults to 100 if not specified	No	LimitClause
includeDeleted	query	Whether to included type definitions that have been marked as deleted.	No	boolean

# Responses

Code	Description	Schema
200	List of type definitions that were found	feedResponseTypeDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Model definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# POST Add a New Type Definition

# /modelDefinitions/{modelId}/types

# Description

Adds a new type definition to the given model definition. The type definition must be either a new typeId, or the provided version property must conform to the semantic versioning rules for type definitions. Otherwise, the request will be rejected. Note that there is NO update of a type definition. If changes need to be made, at minimum a minor or patch version increase is required. Therefore, there is also no PUT operation on this endpoint.

# Parameters

Name	Located in	Description	Required	Schema
modelId	path	Model definition ID	Yes	string

# Responses

Code	Description	Schema
201	Type definition was added to database	typeDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Retrieve a Type Definition

# /modelDefinitions/{modelId}/types/{typeId}

# Description

Gets latest (based on its version) type definition based on versions for specific modelId and typeId. Deleted type definitions can also be retrieved by this operation, if the includeDeleted flag is set to "true".

# Parameters

Name	Located in	Description	Required	Schema
modelId	path	model definition ID	Yes	string
typeId	path	type definition ID	Yes	string
includeDeleted	query	Whether to included type definitions that have been marked as deleted.	No	boolean

# Responses

Code	Description	Schema
200	type definition	typeDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Type definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# DELETE Delete a Type Definition

# /modelDefinitions/{modelId}/types/{typeId}

# Description

Marks the type definition as deleted. No new instances can be created and no new versions added. The type definition will stay in the database though, as this is a soft delete. To delete the entity completely (hard delete), please contact the Operations Team.

# Parameters

Name	Located in	Description	Required	Schema
modelId	path	Model definition ID	Yes	string
typeId	path	Type definition ID	Yes	string

# Responses

Code	Description	Schema
204	type definition successfully marked as deleted.	object
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Type definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Get Type Definition Versions

# /modelDefinitions/{modelId}/types/{typeId}/versions

# Description

Retrieves a list of available versions for the given typeId. In order to retrieve the versions of a soft-deleted type definition, the includeDeleted flag must be set to "true".

# Parameters

Name	Located in	Description	Required	Schema
modelId	path	Model definition ID	Yes	string
typeId	path	Type definition ID	Yes	string
includeDeleted	query	Whether to retrieve a type definitions that has been marked as deleted.	No	boolean

# Responses

Code	Description	Schema
200	List of available versions of the type definition	versionsList
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Type definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Get Type Definition by Version Number

# /modelDefinitions/{modelId}/types/{typeId}/versions/{version}

# Description

Retrieves a specific type definition identified by its modelId and typeId. Additionally, a version number needs to be supplied which can be partial (e.g., 1 or 1.1) which means that the latest sub-version of that version will be returned (e.g., 1.2.5 or 1.1.3). In order to retrieve the specified version of a soft-deleted type definition, the includeDeleted flag must be set to "true".

# Parameters

Name	Located in	Description	Required	Schema
modelId	path	model definition ID	Yes	string
typeId	path	type definition ID	Yes	string
version	path	(Partial) version number	Yes	string
includeDeleted	query	Whether to retrieve a type definition that has been marked as deleted.	No	boolean

# Responses

Code	Description	Schema
200	Type definition that was found	typeDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Type definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET GET Query Type Definitions with workflow

# /typeDefinitions/types/workFlow

# Description

Gets type definitions from database with workflow information.

# Filterable properties:

modelId: string
typeId : string
name: string
status: string
tags: array[string]
components: object

# Parameters

Name	Located in	Description	Required	Schema
modelId	path	Model definition ID	Yes	string
filter	query	A boolean expression used to filter the results	No	WhereClause
limit	query	Limit the number of returned values. Defaults to 100 if not specified	No	LimitClause
sort	query	Sorts the value based on SortColumn SortDirection eg: modelId desc	No	sortClause
page	query	Indicates page number. default value is set to 1	No	integer
includeDeleted	query	Whether to included model definitions that have been marked as deleted.	No	boolean

# Responses

Code	Description	Schema
200	List of typeDefinitions with workflow information	typeDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Type definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET GET Query list of typeIds

# /typeDefinitions/typeIdList

# Description

Retrieves list of type Ids for all existing Model Definitions from database.

# Filterable properties:

modelId: string
typeId : string
name: string
status: string
tags: array[string]
components: object

# Parameters

Name	Located in	Description	Required	Schema
modelId	path	Model definition ID	Yes	string
filter	query	A boolean expression used to filter the results	No	WhereClause
limit	query	Limit the number of returned values. Defaults to 100 if not specified	No	LimitClause
sort	query	Sorts the value based on SortColumn SortDirection eg: modelId desc	No	sortClause
page	query	Indicates page number. default value is set to 1	No	integer
includeDeleted	query	Whether to included model definitions that have been marked as deleted.	No	boolean

# Responses

Code	Description	Schema
200	A list of type Ids	typeDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Type definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# PUT Bulk Update Type Definitions Group

# /typeDefinitions/groupUpdate

# Description

Bulk Update multiple TypeDefinition based on given group.

# Parameters

Name	Located in	Description	Required	Schema
includeDeleted	query	Whether to included model definitions that have been marked as deleted.	No	boolean

# Responses

Code	Description	Schema
204	Type definition.	feedResponseModelDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Type definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# PUT Revokes all Versions or Specfic Version of Type Definitions

# /modelDefinitions/{modelId}/types/{typeId}

# Description

Revokes existing TypeDefinition to the given ModelDefinition. If user provides only Type Definition Id all versions will be revoked. If specific version is given, then TypeDefinition for the specific ver-sion will be revoked.

# Parameters

Name	Located in	Description	Required	Schema
modelId	path	Model definition ID	Yes	string
typeId	path	Type definition ID	Yes	string

# Responses

Code	Description	Schema
200	Revokes Type definition.	feedResponseModelDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Type definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Retrieve a Type Definition in Same Unique Group

# /modelDefinitions/{modelId}/uniqueGroup/{typeId}/types

# Description

Retrieves a list of typeIds for types in same unique group.

# Parameters

Name	Located in	Description	Required	Schema
modelId	path	model definition ID	Yes	string
typeId	path	type definition ID	Yes	string
includeDeleted	query	Whether to included type definitions that have been marked as deleted.	No	boolean

# Responses

Code	Description	Schema
200	list of type definitions same unique group	typeDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Type definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Query Aggregate groupBy

# /typeDefinitions/aggregate/{groupBy}

# Description

Retrieves the list of groups and their corresponding counts for all existing Type Definitions.

Filterable properties:

model: string
group: string
status: string

# Parameters

Name	Located in	Description	Required	Schema
filter	query	A boolean expression used to filter the results	No	WhereClause
limit	query	Limit the number of returned values. Defaults to 100 if not specified	No	LimitClause
sort	query	Sorts the value based on SortColumn SortDirection eg: modelId desc	No	sortClause
groupBy	query	groupBys either group/name/model.Default value is set to group	No	[groupBy-Clause] (/api/data/api-data-models.md#groupbyclause)
page	query	Indicates page number. default value is set to 1	No	integer
includeDeleted	query	Whether to included model definitions that have been marked as deleted.	No	boolean

# Responses

Code	Description	Schema
200	A list of groups	Group
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Model definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# PUT Revoke soft-deleted Type Definition

# /modelDefinitions/{modelId}/types/{typeId}

# Description

Revokes existing TypeDefinition to the given ModelDefinition. If user provides only Type Definition Id all versions will be revoked. If specific version is given then TypeDefinition for the specific version will be revoked.

# Parameters

Name	Located in	Description	Required	Schema
modelId	path	Model definition ID	Yes	string
typeId	path	Type definition ID	Yes	string

# Responses

Code	Description	Schema
200	Revokes Type definition	feedResponseModelDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Type definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# GET Delete a specific version of Type Definition

# /modelDefinitions/{modelId}/types/{typeId}/versions/{version}

# Description

Marks the TypeDefinition as deleted. No new instances can be created and no new versions added. The TypeDefinition will stay in the database though.

# Parameters

Name	Located in	Description	Required	Schema
modelId	path	model definition ID	Yes	string
typeId	path	type definition ID	Yes	string
version	path	(Partial) version number	Yes	string

# Responses

Code	Description	Schema
200	Type definition was successfully deleted.
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
404	Type definition not found	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

← Models Objects →