Variants 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": {
      "Type": "text",
      "Name": "text",
      "Slug": "text",
      "Description": "text"
    },
    "Learner": {
      "Type": "text",
      "Name": "text",
      "Slug": "text",
      "Description": "text"
    },
    "PrimaryProfile": {
      "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/variants/cmds/compliance-summaries

HTTPcURLJavaScriptPython

POST /v2/e01/api/variants/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": {
      "Type": "text",
      "Name": "text",
      "Slug": "text",
      "Description": "text"
    },
    "Learner": {
      "Type": "text",
      "Name": "text",
      "Slug": "text",
      "Description": "text"
    },
    "PrimaryProfile": {
      "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
    }
  }
]