Variant API: CMDS

post

Authorizations

Bearer

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

departmentsstring · uuid[] · nullableOptional

learnersstring · uuid[] · nullableOptional

measurementsinteger · int32[] · nullableOptional

profileConditioninteger · int32Optional

learnerMustHaveProfilebooleanOptional

departmentEmploymentboolean · nullableOptional

organizationEmploymentboolean · nullableOptional

dataAccessboolean · nullableOptional

zeroRequirementsProgressDisplaystring · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/plugin/cmds/compliance-summaries

HTTPcURLJavaScriptPython

POST /v2/e01/api/plugin/cmds/compliance-summaries HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 295

{
  "departments": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "learners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "measurements": [
    1
  ],
  "profileCondition": 1,
  "learnerMustHaveProfile": true,
  "departmentEmployment": true,
  "organizationEmployment": true,
  "dataAccess": true,
  "zeroRequirementsProgressDisplay": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "department": {
      "identifier": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "name": "text",
      "slug": "text",
      "description": "text"
    },
    "learner": {
      "identifier": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "name": "text",
      "slug": "text",
      "description": "text"
    },
    "primaryProfile": {
      "identifier": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "name": "text",
      "slug": "text",
      "description": "text"
    },
    "measurement": {
      "key": 1,
      "name": "text",
      "score": 1,
      "required": 1,
      "satisfied": 1,
      "expired": 1,
      "notCompleted": 1,
      "notApplicable": 1,
      "needsTraining": 1,
      "selfAssessed": 1,
      "submitted": 1,
      "validated": 1
    }
  }
]

post

Authorizations

Bearer

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

departmentsstring · uuid[] · nullableOptional

learnersstring · uuid[] · nullableOptional

measurementsinteger · int32[] · nullableOptional

profileConditioninteger · int32Optional

learnerMustHaveProfilebooleanOptional

departmentEmploymentboolean · nullableOptional

organizationEmploymentboolean · nullableOptional

dataAccessboolean · nullableOptional

zeroRequirementsProgressDisplaystring · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/variant/cmds/compliance-summaries

HTTPcURLJavaScriptPython

POST /v2/e01/api/variant/cmds/compliance-summaries HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 295

{
  "departments": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "learners": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "measurements": [
    1
  ],
  "profileCondition": 1,
  "learnerMustHaveProfile": true,
  "departmentEmployment": true,
  "organizationEmployment": true,
  "dataAccess": true,
  "zeroRequirementsProgressDisplay": "text"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "department": {
      "identifier": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "name": "text",
      "slug": "text",
      "description": "text"
    },
    "learner": {
      "identifier": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "name": "text",
      "slug": "text",
      "description": "text"
    },
    "primaryProfile": {
      "identifier": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "name": "text",
      "slug": "text",
      "description": "text"
    },
    "measurement": {
      "key": 1,
      "name": "text",
      "score": 1,
      "required": 1,
      "satisfied": 1,
      "expired": 1,
      "notCompleted": 1,
      "notApplicable": 1,
      "needsTraining": 1,
      "selfAssessed": 1,
      "submitted": 1,
      "validated": 1
    }
  }
]