Contract APIs

The following APIs can be used to interact with the contracts of a multi-tenant implementation of the Platform.

GET Query Contracts

/contracts

Parameters

Name	Located in	Description	Required	Schema
solutionId	query	Search by solution identifier	No	string
tenantId	query	Search by tenant identifier	No	string
name	query	Search by name	No	string
tags	query	Search by one or more tags	No	[ string ]
limit	query	Limit the number of returned values	No	integer
sort	query	Sort the results ("name asc" or "name desc")	No	string
page	query	Must be a positive number, default value is 1	No	integer

Responses

Code	Description	Schema
200	Success	ListResponse.Contract
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
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 Create a Contract

/contracts

Responses

Code	Description	Schema
201	Resource created	InlineResponse201
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	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
409	Conflict	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time
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 a Contract

/contracts/{contractId}

Parameters

Name	Located in	Description	Required	Schema
contractId	path	Contract ID	Yes	string

Responses

Code	Description	Schema
200	Success	Permission
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	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time
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 Update a Contract

/contracts/{contractId}

Parameters

Name	Located in	Description	Required	Schema
contractId	path	contract identifier	Yes	string
Ability-Correlation-Id	header		No	string

Responses

Code	Description	Schema
204	Success
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	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time
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 Contract

/contracts/{contractId}

Parameters

Name	Located in	Description	Required	Schema
contractId	path	contract identifier	Yes	string

Responses

Code	Description	Schema
204	Success
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	Not found. One or more resources were not found, response may contain details about missing resources	ServiceErrors
429	Too many requests - indicates the user has sent too many requests in a given amount of time
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