Certifications (v1-2025-04-18)

The Certifications API provides all the capabilities for managing the certification process beginning with your Certification Program. You can also manage Applications, Courses, or Course Offerings from this API.

Like most of the other Rhythm apps, the Certifications API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

Download OpenAPI description

certifications-v1.json

certifications-v1.yaml

Servers

Mock server

https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/

https://certifications.api.rhythmsoftware.com/

Activities

Operations

Activity Reg Processes

Operations

Activity Types

Operations

App Reference Processes

Operations

App Reference Types

Operations

App Status Reasons

Operations

Application Fees

Operations

Application Notices

Operations

Application Processes

Operations

Application References

Operations

Applications

Operations

Billing Run Actions

Operations

Billing Runs

Operations

Billing Templates

Operations

Certifications

Operations

Coupons

Operations

Course Fees

Operations

Course Instructors

Operations

Returns a list of records with the specified tenant_id

Request

Returns a list of records with the specified tenant_id

Path

tenantIdstringrequired

The tenant

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseInstructors/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

ItemsArray of objects(CourseInstructor)

LastEvaluatedKeystring

Response

application/json

{
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Creates a new course instructor record that does not already exist.

Request

This method will auto-generate an ID and create a new course instructor. If an ID is specified for the course instructor, an error will be thrown.

Path

tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The course instructor that you would like to be saved.

contract_uristring(file)(Contract Uri)

A link to the contract

coursesArray of objects

custom_field_valuesArray of objects(Custom Field Values)

idstring(ID)/^[\w|-]+$/required

The unique, string identifier of this course instructor

is_activeboolean(Is Active)

Whether or not this course instructor is active

notesstring(Notes)

Notes on this instructor

pay_ratenumber(float)(Pay Rate)

The contract rate for the instructor

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_idstring(Training Provider)required

The training provider

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseInstructors/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contract_uri": "string",
    "courses": [
      {
        "course_id": "string",
        "valid_from": "2019-08-24",
        "valid_until": "2019-08-24"
      }
    ],
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "id": "string",
    "is_active": true,
    "notes": "string",
    "pay_rate": 0.1,
    "sys_bulk_load_id": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_locked": true,
    "sys_version": 0.1,
    "training_provider_id": "string"
  }'

Responses

The course instructor was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

contract_uristring(file)(Contract Uri)

A link to the contract

coursesArray of objects

custom_field_valuesArray of objects(Custom Field Values)

idstring(ID)/^[\w|-]+$/required

The unique, string identifier of this course instructor

is_activeboolean(Is Active)

Whether or not this course instructor is active

notesstring(Notes)

Notes on this instructor

pay_ratenumber(float)(Pay Rate)

The contract rate for the instructor

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_idstring(Training Provider)required

The training provider

Response

application/json

{
  "contract_uri": "string",
  "courses": [
    { … }
  ],
  "custom_field_values": [
    { … }
  ],
  "id": "string",
  "is_active": true,
  "notes": "string",
  "pay_rate": 0.1,
  "sys_bulk_load_id": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_locked": true,
  "sys_version": 0.1,
  "training_provider_id": "string"
}

Returns a course instructor from the system by its ID.

Request

This method will delete a course instructor with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the course instructor to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseInstructors/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The course instructor was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Returns a course instructor from the system by its ID.

Request

This method will look up a course instructor by the specified ID and return it back.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the course instructor to return.

Query

fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseInstructors/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The course instructor was retrieved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

contract_uristring(file)(Contract Uri)

A link to the contract

coursesArray of objects

custom_field_valuesArray of objects(Custom Field Values)

idstring(ID)/^[\w|-]+$/required

The unique, string identifier of this course instructor

is_activeboolean(Is Active)

Whether or not this course instructor is active

notesstring(Notes)

Notes on this instructor

pay_ratenumber(float)(Pay Rate)

The contract rate for the instructor

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_idstring(Training Provider)required

The training provider

Response

application/json

{
  "contract_uri": "string",
  "courses": [
    { … }
  ],
  "custom_field_values": [
    { … }
  ],
  "id": "string",
  "is_active": true,
  "notes": "string",
  "pay_rate": 0.1,
  "sys_bulk_load_id": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_locked": true,
  "sys_version": 0.1,
  "training_provider_id": "string"
}

Partially updates a course instructor with the specified ID.

Request

This method will patch an existing course instructor with the specified ID, using the HTTP PATCH specification.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the course instructor to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [

opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"

pathstring(Path)required

The JSON path

valuestring(Value)

The updated value

]

curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseInstructors/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The course instructor was patched successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

contract_uristring(file)(Contract Uri)

A link to the contract

coursesArray of objects

custom_field_valuesArray of objects(Custom Field Values)

idstring(ID)/^[\w|-]+$/required

The unique, string identifier of this course instructor

is_activeboolean(Is Active)

Whether or not this course instructor is active

notesstring(Notes)

Notes on this instructor

pay_ratenumber(float)(Pay Rate)

The contract rate for the instructor

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_idstring(Training Provider)required

The training provider

Response

application/json

{
  "contract_uri": "string",
  "courses": [
    { … }
  ],
  "custom_field_values": [
    { … }
  ],
  "id": "string",
  "is_active": true,
  "notes": "string",
  "pay_rate": 0.1,
  "sys_bulk_load_id": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_locked": true,
  "sys_version": 0.1,
  "training_provider_id": "string"
}

Updates a course instructor with the specified ID.

Request

This method will update an existing course instructor with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the course instructor to update.

Bodyapplication/jsonrequired

The updated course instructor that will be saved.

contract_uristring(file)(Contract Uri)

A link to the contract

coursesArray of objects

custom_field_valuesArray of objects(Custom Field Values)

idstring(ID)/^[\w|-]+$/required

The unique, string identifier of this course instructor

is_activeboolean(Is Active)

Whether or not this course instructor is active

notesstring(Notes)

Notes on this instructor

pay_ratenumber(float)(Pay Rate)

The contract rate for the instructor

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_idstring(Training Provider)required

The training provider

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/certifications/certifications-v1/courseInstructors/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "contract_uri": "string",
    "courses": [
      {
        "course_id": "string",
        "valid_from": "2019-08-24",
        "valid_until": "2019-08-24"
      }
    ],
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "id": "string",
    "is_active": true,
    "notes": "string",
    "pay_rate": 0.1,
    "sys_bulk_load_id": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_locked": true,
    "sys_version": 0.1,
    "training_provider_id": "string"
  }'

Responses

The course instructor was updated successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

contract_uristring(file)(Contract Uri)

A link to the contract

coursesArray of objects

custom_field_valuesArray of objects(Custom Field Values)

idstring(ID)/^[\w|-]+$/required

The unique, string identifier of this course instructor

is_activeboolean(Is Active)

Whether or not this course instructor is active

notesstring(Notes)

Notes on this instructor

pay_ratenumber(float)(Pay Rate)

The contract rate for the instructor

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

training_provider_idstring(Training Provider)required

The training provider

Response

application/json

{
  "contract_uri": "string",
  "courses": [
    { … }
  ],
  "custom_field_values": [
    { … }
  ],
  "id": "string",
  "is_active": true,
  "notes": "string",
  "pay_rate": 0.1,
  "sys_bulk_load_id": "string",
  "sys_bulk_load_record_no": 0.1,
  "sys_bulk_load_source_file": "string",
  "sys_created_at": "2019-08-24T14:15:22Z",
  "sys_created_by_id": "string",
  "sys_directive": "string",
  "sys_external_id": "string",
  "sys_last_modified_at": "2019-08-24T14:15:22Z",
  "sys_last_modified_by_id": "string",
  "sys_locked": true,
  "sys_version": 0.1,
  "training_provider_id": "string"
}

Course Offerings

Operations

Course Reg Processes

Operations

Course Registrations

Operations

Course Types

Operations

Courses

Operations

Credit Types

Operations

Credits

Operations

Directories

Operations

Exam Fees

Operations

Exam Notices

Operations

Exam Offerings

Operations

Exam Reg Processes

Operations

Exam Registrations

Operations

Exam Sites

Operations

Exams

Operations

Expiration Rule Sets

Operations

Fees

Operations

Instructors

Operations

License Types

Operations

Notices

Operations

Profiles

Operations

Program Groups

Operations

Programs

Operations

Project Types

Operations

Query Definitions

Operations

Recurring Billing Runs

Operations

Settings

Operations

Statistics

Operations

Status Reasons

Operations

Testing Facilities

Operations

Training Locations

Operations

Training Prov Programs

Operations

Training Providers

Operations

Certifications (v1-2025-04-18)

Activities

Activity Reg Processes

Activity Types

App Reference Processes

App Reference Types

App Status Reasons

Application Fees

Application Notices

Application Processes

Application References

Applications

Billing Run Actions

Billing Runs

Billing Templates

Certifications

Coupons

Course Fees

Course Instructors

Returns a list of records with the specified tenant_id

Request

Responses

Was this helpful?

Creates a new course instructor record that does not already exist.

RequestExpand all

Responses

Was this helpful?

Returns a course instructor from the system by its ID.

Request

Responses

Was this helpful?

Returns a course instructor from the system by its ID.

Request

Responses

Was this helpful?

Partially updates a course instructor with the specified ID.

Request

Responses

Was this helpful?

Updates a course instructor with the specified ID.

RequestExpand all

Responses

Was this helpful?

Course Offerings

Course Reg Processes

Course Registrations

Course Types

Courses

Credit Types

Credits

Directories

Exam Fees

Exam Notices

Exam Offerings

Exam Reg Processes

Exam Registrations

Exam Sites

Exams

Expiration Rule Sets

Fees

Instructors

License Types

Notices

Profiles

Program Groups

Programs

Project Types

Query Definitions

Recurring Billing Runs

Settings

Statistics

Status Reasons

Testing Facilities

Training Locations

Training Prov Programs

Training Providers

Request

Request