Skip to content
AveraAveraAvera Documentation

Plan a campaign of executions in one commit

POST
/api/v1/projects/{projectId}/executions/plan
curl --request POST \
  --url https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/executions/plan \
  --header 'Content-Type: application/json' \
  --data '{ "instrumentIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "executionItemType": "example", "runId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "configurationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "executedBy": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Creates one OPEN execution per instrument, under one run and one configuration and assigned to one executor, as a single commit. Refuses an instrument that belongs to another project or is not RELEASED.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
instrumentIds
required
Array<string>
>= 1 items
executionItemType
string | null
runId
string | null format: uuid
configurationId
string | null format: uuid
executedBy
string | null format: uuid

Example generated

{
  "instrumentIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "executionItemType": "example",
  "runId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "configurationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "executedBy": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
Array<object>
object
id
required
string format: uuid
itemTypeId
required
string
canonicalId
required
string format: uuid
number
required
string
revision
string | null
seq
required
integer format: int64
status
required
string
Allowed values: DRAFT REVIEW RELEASED OBSOLETE
workflowStateId
required
string
projectId
required
string format: uuid
branchId
required
string format: uuid
createdAt
required
string format: date-time
createdBy
required
string format: uuid
modifiedAt
required
string format: date-time
modifiedBy
required
string format: uuid
attributes
object | null
wasEverReleased
boolean | null
frozenAttributeIds
Array<string> | null