Create project-scoped indicator

POST

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

curl --request POST \
  --url https://localhost:10001/api/v2/projects/1/indicators \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "criteria": [ {} ], "declarationProfile": { "emitOn": "pass", "statementTemplate": "example", "titleTemplate": "example" }, "description": "example", "extractionRules": {}, "name": "example", "parameters": {}, "provider": "example", "slug": "example", "tags": [ "example" ], "triggerType": "event", "type": "custom" }'

Creates an immutable indicator template owned by a project and returns the created template

Authorizations

• BearerAuth

Parameters

Path Parameters

projectId

required

integer

Project ID

Request Body

Project indicator creation request

Media type application/json

object

criteria

Array<object>

object

declarationProfile

required

object

emitOn

“pass” | “fail” | “both” | “none”

string

Allowed values: pass fail both none

statementTemplate

string

titleTemplate

string

description

string

extractionRules

object

name

required

string

parameters

object

provider

string

slug

string

tags

Array<string>

triggerType

required

string

Allowed values: event

type

required

string

Allowed values: custom

Responses

201

Created project indicator template

Media type application/json

object

createdAt

string

criteria

Array<object>

object

declarationProfile

object

emitOn

“pass” | “fail” | “both” | “none”

string

Allowed values: pass fail both none

statementTemplate

string

titleTemplate

string

description

string

extractionRules

object

id

string

name

string

parameters

object

projectId

integer

provider

string

slug

string

tags

Array<string>

triggerType

string

Allowed values: event

type

string

Allowed values: custom

updatedAt

string

usageCount

integer

Example

{
  "declarationProfile": {
    "emitOn": "pass"
  },
  "triggerType": "event",
  "type": "custom"
}

400

Bad request - Invalid request body or indicator fields

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

404

Project not found

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

409

Indicator with the same slug already exists

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}

500

Internal server error

Media type application/json

object

key

additional properties

string

Example ^generated

{
  "additionalProperty": "example"
}