Resource Names: List

Get a list of resource names for an account for a given resource type.

resourceGroup and resourceSubType combine to describe the type of resource to query.

Examples: km/entity, platform/account-features.

path Parameters
accountId
required
string
resourceGroup
required
string

Group of the resource

For example, for km/entity, the resourceGroup is km

resourceSubType
required
string

Subtype of the resource

For example, for km/entity, the resourceSubType is entity

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": [
    ]
}

Resource Configuration: Get

Get a resource configuration.

resourceGroup and resourceSubType combine to describe the type of resource to return.

Examples: km/entity, platform/account-features.

resourceId describes the specific resource to return, matching the $id field of the resource configuration.

To return the resource configuration of singleton resources (resources without $id fields like km/settings and platform/account-features), specify config as the resourceId.

Example: platform/account-features/config

path Parameters
accountId
required
string
resourceId
required
string

$id (name) of the resource

resourceGroup
required
string

Group of the resource

For example, for km/entity, the resourceGroup is km

resourceSubType
required
string

Subtype of the resource

For example, for km/entity, the resourceSubType is entity

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": { }
}

Resource Configuration: Update

Update a resource configuration.

resourceGroup and resourceSubType combine to describe the type of resource to return.

Examples: km/entity, platform/account-features.

resourceId describes the specific resource to return, matching the $id field of the resource configuration.

To update the resource configuration of singleton resources (resources without $id fields like km/settings and platform/account-features), specify config as the resourceId.

Example: platform/account-features/config

path Parameters
accountId
required
string
resourceId
required
string

$id (name) of the resource

resourceGroup
required
string

Group of the resource

For example, for km/entity, the resourceGroup is km

resourceSubType
required
string

Subtype of the resource

For example, for km/entity, the resourceSubType is entity

query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
object

A JSON representation of the resource. Please refer to the Hitchhiker's guide for the exact resource schema.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": { }
}

Resource Configuration: Create

Create a new resource for a given resource type.

resourceGroup and resourceSubType combine to describe the type of resource to create.

Examples: km/entity, platform/account-features.

path Parameters
accountId
required
string
resourceGroup
required
string

Group of the resource

For example, for km/entity, the resourceGroup is km

resourceSubType
required
string

Subtype of the resource

For example, for km/entity, the resourceSubType is entity

query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
object

A JSON representation of the resource. Please refer to the Hitchhiker's guide for the exact resource schema.

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": { }
}
Feedback