REST API for Configurator v1.0
Created Dec 18, 2020 at 07:15 PM

Resource: jobs

All scheduled/inprogress/completed job list.

http://{device}/api/cmc.configurator/1.0/jobs{?job_status,feature_id,after,before}
  • JSON
  • [ job ]
    Property Name Type Description Notes
    jobs <array of <job>> All scheduled/inprogress/completed job list.
    jobs[items] <job> Job Scheduling resource.

    Resource: job

    Job Scheduling resource.

    http://{device}/api/cmc.configurator/1.0/jobs/items/{id}
  • JSON
  • {
      "id": integer,
      "site_ids": [
        integer
      ],
      "appliance_serial_numbers": [
        string
      ],
      "operation": string,
      "idx": integer,
      "timestamp": integer,
      "site_type_ids": [
        integer
      ],
      "feature_ids": [
        integer
      ],
      "creation_time": integer,
      "push_time": multiple,
      "completion_time": multiple,
      "error_text": multiple,
      "job_status": string,
      "backup": boolean,
      "detailed_status": [
        {
          "feature_id": integer,
          "status": interpreter_job_status,
          "serialnum": string,
          "result": interpreter_job_result,
          "error_text": multiple
        }
      ]
    }
    Property Name Type Description Notes
    job <object> Job Scheduling resource. Required properties: [feature_ids];
    job.id <integer> Read-only; Optional;
    job.site_ids <array of <integer>> Array of site ids. Optional; Minimum: 1 items;
    job.site_ids[items] <integer>
    job.appliance_serial_numbers <array of <string>> Array of appliance serial number. Optional; Minimum: 1 items;
    job.appliance_serial_numbers[items] <string>
    job.operation <string> Optional;
    job.idx <integer> Optional;
    job.timestamp <integer> Optional;
    job.site_type_ids <array of <integer>> Array of site types to push onto. Optional; Minimum: 1 items;
    job.site_type_ids[items] <integer>
    job.feature_ids <array of <integer>> Array of feature ids. Minimum: 1 items;
    job.feature_ids[items] <integer>
    job.creation_time <integer> Creation time of the job. Read-only; Optional;
    job.push_time <multiple> Push time of the job. This will be present for jobs whose state is one of 'IN_PROGRESS', 'FAILED', 'SUCCESS' Optional;
    job.push_time.anyOf[0] <integer> Read-only;
    job.push_time.anyOf[1] <null>
    job.completion_time <multiple> Completion time of the job. Optional;
    job.completion_time.anyOf[0] <integer> Read-only;
    job.completion_time.anyOf[1] <null>
    job.error_text <multiple> Error text if pre push failed. Key needs to be checked if it exist before you try to access it. Optional;
    job.error_text.anyOf[0] <string> Read-only;
    job.error_text.anyOf[1] <null>
    job_status <string> Status of the submitted job. Read-only; Values: Queued, InProgress, Failed, Success, Canceled;
    job.backup <boolean> Flag to indicate if the user wants to take a back up or not. Optional;
    job.detailed_status <array of <object>> Read-only; Optional;
    job.detailed_status[items] <object> Read-only;
    job.detailed_status[items].feature_id <integer> Read-only; Optional;
    job.detailed_status[items].status <interpreter_job_status> The status of the job submitted to the interpreter Read-only; Values: Pending, Running, Completed;
    job.detailed_status[items].serialnum <string> Read-only; Optional;
    job.detailed_status[items].result <interpreter_job_result> the result of the job submitted to the interpreter Read-only; Values: Fail, Success;
    job.detailed_status[items].error_text <multiple> Error text if push pushed for a particular feature. Read-only; Optional;
    job.detailed_status[items].error_text.
    anyOf[0]
    <string> Read-only;
    job.detailed_status[items].error_text.
    anyOf[1]
    <null> Read-only;
    job.oneOf[0] <object> Required properties: [site_ids];
    job.oneOf[0].<prop> <any> Optional;
    job.oneOf[1] <object> Required properties: [appliance_serial_numbers];
    job.oneOf[1].<prop> <any> Optional;
    job.oneOf[2] <object> Required properties: [site_type_ids];
    job.oneOf[2].<prop> <any> Optional;

    Relations

    job: instances

    Related resource

    jobs

    Resource: feature

    Resource to get a particular feature.

    http://{device}/api/cmc.configurator/1.0/features/items/{id}
  • JSON
  • {
      "id": integer,
      "name": string,
      "pretty_name": string,
      "description": string,
      "push_enable": boolean
    }
    Property Name Type Description Notes
    feature <object> Resource to get a particular feature. Required properties: [push_enable];
    feature.id <integer> Read-only; Optional;
    feature.name <string> Name of the feature. Read-only; Optional;
    feature.pretty_name <string> Pretty name of the feature. Read-only; Optional;
    feature.description <string> Description of the feature. Read-only; Optional;
    feature.push_enable <boolean> Whether push should be enabled for this feature or not.

    Resource: features

    Resource to get the features supported.

    http://{device}/api/cmc.configurator/1.0/features{?name}
  • JSON
  • [ feature ]
    Property Name Type Description Notes
    features <array of <feature>> Resource to get the features supported.
    features[items] <feature> Resource to get a particular feature.

    Type: job_status

    The status of the job

  • JSON
  • string
    Property Name Type Description Notes
    job_status <string> The status of the job Read-only; Values: Queued, InProgress, Failed, Success, Canceled;

    Type: interpreter_job_status

    The status of the job submitted to the interpreter

  • JSON
  • string
    Property Name Type Description Notes
    interpreter_job_status <string> The status of the job submitted to the interpreter Read-only; Values: Pending, Running, Completed;

    Type: interpreter_job_result

    the result of the job submitted to the interpreter

  • JSON
  • string
    Property Name Type Description Notes
    interpreter_job_result <string> the result of the job submitted to the interpreter Read-only; Values: Fail, Success;