Skip to content
AveraAveraAvera Documentation

Start an execution of an instrument

POST
/api/v1/items/{instrumentId}/executions
curl --request POST \
  --url https://app.avera.io/api/v1/items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/executions \
  --header 'Content-Type: application/json' \
  --data '{ "title": "example", "executionItemType": "example", "runId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "configurationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "executedBy": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "attributes": { "additionalProperty": "example" } }'

Creates one OPEN execution item for the instrument, under the run and configuration named in the request. Refuses an instrument that is not RELEASED. The execution type is derived from the meta-model and must be named only when several types execute this instrument’s type. The executed instrument version is cited by the link to the instrument, never copied. Completing and voiding are lifecycle transitions on the execution item.

Parameters

Section titled “Parameters”

Path Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
title
string | null
executionItemType
string | null
runId
string | null format: uuid
configurationId
string | null format: uuid
executedBy
string | null format: uuid
attributes
required
object
key
additional properties

Example generated

{
  "title": "example",
  "executionItemType": "example",
  "runId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "configurationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "executedBy": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "attributes": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
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