Skip to content
PIE V2 API

Create or update a service model assignment by key

PUT
/v2/clients/{client_id}/domains/{domain_id}/service/{service_id}/assignments/{assignment_key}
 
curl --request PUT \
  --url https://pie.streamline.enterprises/v2/clients/client-1/domains/south_australia/service/service-1/assignments/default \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "assignment_key": "example", "model_id": "example", "model_version": "example", "status": "active", "role": "example", "settings": {}, "metadata": {} }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
client_id
required
string
Example 
client-1
domain_id
required
string
Example 
south_australia
service_id
required
string
Example 
service-1
assignment_key
required
string
Example 
default

Request Body required

Section titled “Request Body required ”
Media type application/json
object
assignment_key

Required on collection POST routes; omitted on keyed PUT routes.

string
model_id
required
string
model_version
required
string
status

New assignment revisions are active by default. Use archived to retire a capability without launching new jobs from it.

string
default: active
Allowed values: active archived
role
string
nullable
settings
object
metadata
object

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Service assignment upserted

Media type 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"
}

400

Section titled “400 ”

Validation error — malformed input, invalid path parameters, or request that fails syntactic validation.

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}

401

Section titled “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).

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}

403

Section titled “403 ”

Authenticated caller lacks the permission required for this operation.

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}

404

Section titled “404 ”

Requested resource was not found.

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}

422

Section titled “422 ”

Semantically invalid request — e.g. domain not active, no model assigned, feature contract mismatch, or invalid feature definitions.

Media type application/json
object
success
required
boolean
message
required

Human-readable error message

string
Example 
{
  "success": false
}