Resource Management API

Note

See the Resource Management feature topic for details about how to use this API.

Endpoint Index

Action	Endpoint
Deploy resources in bulk	PUT /configuration/products/{productName}/resources
Deploy resources by type	PUT /configuration/products/{productName}/resources/{resourcesType}
Fetch resources	GET /configuration/products/{productName}/resources/{resourcesType}
Fetch resources by locator	GET /configuration/products/{productName}/resources/{resourcesType}/{locator}
Delete resource by locator	DELETE /configuration/products/{productName}/resources/{resourcesType}/{locator}
List resource timestamps	GET /products/resources/timestamps/

Details

Zip file structure sample available here:

Zip file structure:

resources.zip
|-- tables/
|-- staticDocuments/
|-- documentTemplates/
|-- formulaTemplates/

Deploy resources in bulk¶

PUT /configuration/products/{productName}/resources

Request:

Name	Position	Type	Required
effectiveTimestamp	formdata	timestamp	optional
productName	path	string	required
zipFile	formdata	file	required

Response: [ResourceDeployResponse]

Deploy resources by type¶

PUT /configuration/products/{productName}/resources/{resourcesType}

Request:

Name	Position	Type	Required
effectiveTimestamp	formdata	timestamp	optional
productName	path	string	required
resourcesType	path	string	required
zipFile	formdata	file	required

Response: [ResourceDeployResponse]

ResourceDeployResponse¶

required
locator string
name string
effectiveTimestamp timestamp
urlExpirationTimestamp timestamp
errorDetails string
success boolean
type string
url string

Fetch resources¶

GET /configuration/products/{productName}/resources/{resourcesType}

Request:

Name	Position	Type	Required
effectiveTimestamp	query	timestamp	optional
productName	path	string	required
resourceName	formdata	string	optional
resourcesType	path	string	optional

Response: [ResourceResponse]

Fetch resources by locator¶

GET /configuration/products/{productName}/resources/{resourcesType}/{locator}

Request:

Name	Position	Type	Required
locator	path	string	required
productName	path	string	required
resourcesType	path	string	required

Response: ResourceResponse

ResourceResponse¶

required
locator string
name string
effectiveTimestamp timestamp
urlExpirationTimestamp timestamp
url string

Delete resource by locator¶

DELETE /configuration/products/{productName}/resources/{resourcesType}/{locator}

Request:

Name	Position	Type	Required
locator	path	string	required
productName	path	string	required
resourcesType	path	string	required

Response: ResourceTimestampResponse

List resource timestamps¶

GET /products/resources/timestamps/

Request:

Name	Position	Type	Required
productName	query	string	required

Response: [ResourceTimestampResponse]

ResourceTimestampResponse¶

required
 timestamp