Custom resources

API information

The custom resource is managed by the Resources API.

Note: The Resources API also manages experience and object resources.

Service URLs

Region	URL
AMER	https://resources.amer.xpkit.net
APAC	https://resources.apac.xpkit.net
China	https://resources.china.xpkit.cn
EMEA	https://resources.emea.xpkit.net

OpenAPI Specification

Resource name	Documentation	Download
Custom	View	Link

Example resource (product)

{
    "name": "Macbook Pro",
    "manufacturer": "Apple",
    "available_from": "2021-10-05",
    "stock_level": 24,
    "delivery_available": true,
    "product_image": "http://images.abc.com/macbook_pro_2021.jpg",
    "created": "2021-10-01T14:56:32Z",
    "last_modified": "2021-10-01T03:12:56Z"
}

Notes on custom resources

• The URL structure for the CRUD endpoints is /{% resourceType %}. For naming consistency with all the other resources across the platform, it is recommended you use the singular form for the resource type. For example if you were managing companies the resource type used on the endpoint would be company (/company).