Get a domain model assignment

GET

/v2/clients/{client_id}/domains/{domain_id}/assignments/{assignment_key}

const url = 'https://staging-pie.streamline.enterprises/v2/clients/client-1/domains/south_australia/assignments/default';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://staging-pie.streamline.enterprises/v2/clients/client-1/domains/south_australia/assignments/default \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

client_id

required

string

Example

client-1

domain_id

required

string

Example

south_australia

assignment_key

required

string

Example

default

Responses

200

Domain model assignment

application/json

object

assignment_id

required

Unique revision identifier for this assignment row.

string format: uuid

domain_id

required

string

service_id

string

nullable

assignment_key

required

Stable capability key within the domain or service scope. Updating the same key archives the previous active assignment and creates a new active revision.

string

model_id

required

string

model_version

required

string

status

required

Active assignments are runnable. Archived assignments are retained as historical revisions for jobs that used them.

string

Allowed values: active archived

role

string

nullable

settings

required

object

metadata

required

object

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "status": "active"
}

401

Missing or invalid Authorization bearer token, expired token, or token rejected by the authorization layer (e.g. API Gateway JWT authorizer or application validation).

application/json

object

success

required

boolean

message

required

Human-readable error message

string

Example

{
  "success": false
}

403

Authenticated caller lacks the permission required for this operation.

application/json

object

success

required

boolean

message

required

Human-readable error message

string

Example

{
  "success": false
}

404

Requested resource was not found.

application/json

object

success

required

boolean

message

required

Human-readable error message

string

Example

{
  "success": false
}