Apply project indicator to controls

POST

/api/v2/projects/{projectId}/indicators/{indicatorId}/applications

const url = 'https://localhost:10001/api/v2/projects/example/indicators/example/applications';
const options = {
  method: 'POST',
  headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'},
  body: '{"appliedPolicyControlId":1,"appliedPolicyControlIds":[1],"status":"active"}'
};

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

curl --request POST \
  --url https://localhost:10001/api/v2/projects/example/indicators/example/applications \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "appliedPolicyControlId": 1, "appliedPolicyControlIds": [ 1 ], "status": "active" }'

Creates active or disabled applications for a project indicator on one or more applied policy controls

Authorizations

BearerAuth

Parameters

Path Parameters

projectId

required

string

Project ID, UUID (urn:uuid optional), or slug:my-project

indicatorId

required

string

Indicator UUID (urn:uuid optional) or slug:my-indicator

Request Body

Indicator application request

application/json

object

appliedPolicyControlId

Merged with the plural field

integer

appliedPolicyControlIds

Controls to apply to

Array<integer>

status

Defaults to active

string

Allowed values: active disabled archived

Responses

201

Created indicator applications

application/json

The indicator applications created by applying an indicator to one or more controls

object

applications

Array<object>

An indicator application reduced to its identity and status

object

applicationUuid

Urn:uuid form

string

appliedPolicyControlId

integer

createdAt

string format: date-time

integer

indicatorId

Urn:uuid form

string

lastEvaluatedAt

string format: date-time

status

string

Allowed values: active disabled archived

updatedAt

string format: date-time

Example

{
  "applications": [
    {
      "status": "active"
    }
  ]
}

400

Bad request - Invalid request body or control reference

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

401

Unauthorized - Authentication required

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

403

Forbidden - No project access or insufficient permissions

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

404

Indicator or control not found

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

409

Indicator already applied to the control

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}

500

Internal server error

application/json

Error body returned by the governance endpoints; the message is human-readable and not a stable identifier

object

error

string

Example

{
  "error": "Invalid request body"
}