Resource APIs

The following APIs can be used to interact with Platform resources.

GET Get a Resource in a Given Scope

/resources/{scope}/{resourceType}

Parameters

Name	Located in	Description	Required	Schema
scope	path	Scope	Yes	string
resourceType	path	Resource type	Yes	string

Responses

Code	Description	Schema
200	Success	Resource
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

POST Create a New Resource in a Given Scope

/resources/{scope}/{resourceType}

Parameters

Name	Located in	Description	Required	Schema
scope	path	Scope	Yes	string
resourceType	path	Resource type	Yes	string

Responses

Code	Description	Schema
201	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
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

DELETE Delete a Resource

/resources/{scope}/{resourceType}

Parameters

Name	Located in	Description	Required	Schema
scope	path	Scope	Yes	string
resourceType	path	Type of the Resource	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

GET Query Resources in a Given Scope

/resources/{scope}

Parameters

Name	Located in	Description	Required	Schema
scope	path	Scope	Yes	string
types	query	Search by one or more types	No	[ string ]
solutionId	query	Search by solution identifier	No	string
propertyNames	query	Search by matching property names in the resource	No	[ string ]
tags	query	Search by one or more tags	No	[ string ]
limit	query	Limit the number of returned values	No	integer

Responses

Code	Description	Schema
200	Success	ListResponse.Resource
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