Retrieve the objectives of a plan solution - Kardinal API

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "name": "<string>",
      "priority": 123,
      "value": 123
    }
  ],
  "agencyId": "LND_Agency-42",
  "planId": "plan-AB",
  "planVersion": 42
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

GET

/

agencies

/

{agencyId}

/

plans

/

{planId}

/

solution

/

objectives

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "name": "<string>",
      "priority": 123,
      "value": 123
    }
  ],
  "agencyId": "LND_Agency-42",
  "planId": "plan-AB",
  "planVersion": 42
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "message": "<string>",
      "properties": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

agencyId

string

required

The agency id.

Pattern: ^[A-Z]{3,6}_[a-zA-Z0-9-._~:@!$,]+$

Example:

"LND_Agency-42"

planId

string

required

The plan id. At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "_", "~", ":", "@", "!", "$", ",".

Pattern: ^[a-zA-Z0-9-._~:@!$,]+$

Response

Solution objectives response.

[TO_VALIDATE] Description pending review by a Kardinal engineer.

items

object[]

Show child attributes

agencyId

string

The agency id.

Pattern: ^[A-Z]{3,6}_[a-zA-Z0-9-._~:@!$,]+$

Example:

"LND_Agency-42"

planId

string

The plan id.

Pattern: ^[a-zA-Z0-9-._~:@!$,]+$

Example:

"plan-AB"

planVersion

integer

read-only

The plan version.

Required range: x >= 1

Example:

42