Get Layers in Groups by Query Parameters

post

https://preview.threekit.com/api/layers/groups/{groupBy}

Retrieves layers by query parameters, returned in groups. The response body will have the following have the following fields

Path Params

groupBy

string

required

Value used to group the retrieved layers by. Possible values are jobId, stageId, assetId, orgId, branch.

Query Params

bearer_token

string

Public access token used to authorize the request. Requests may only come from the token's allowed domains. This parameter is mandatory when making requests from a browser. Outside of the browser instead supply a bearer header using a private access token.

orgId

string

Organization ID.

string

ID of a layer

assetId

string

ID of a asset

assetLayer

string

Asset layer

assetLayerConfiguration

string

Configuration of an asset layer. If the asset has no composition(related to layered rendering), the assetLayerConfiguration is the configuration of the asset in question. Must be passed in as by encoding the stringified JSON.

stageId

string

Stage ID

stageConfiguration

string

Configuration of the stage. Must be passed in as a stringified ad encoded JSON.

metadata

string

Metadata of the stage. Must be passed in as a stringified and encoded JSON.

jobId

string

Job ID

branch

string

Name of the org branch to connect to. If no value is provided the default value is "main".

perPage

number

Total number of entries per page, defaults to 30 and can only go up to 100

page

number

Page to return, defaults to 1

sort

string

The direction and value to sort by, defaults to createdAt ascending (denoted +createdAt)

Responses

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns groups information

401User is not authenticated. They must be authenticated to use this service.

403No token was provided in the query string of the request

422User passed a parameter with invalid format