Sign in
perspectives

Starts the PerspectivesJob for the given Parameters. If a job is already running, this will raise an error.

post/perspectives/job/{aspect_id}

Path parameters

aspect_idinteger required

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR

Response

Successful Response

job_idstring required

RQ job ID

job_typestring required

Type of the job

project_idinteger required

Project ID associated with the job

status'queued' | 'finished' | 'failed' | 'started' | 'deferred' | 'scheduled' | 'stopped' | 'canceled' required
status_messagestring nullable

Status message

current_stepinteger required

Current step in the job process

stepsstring[] required

Total number of steps in the job process

{"stackTrail":"components:schemas:PerspectivesJobRead:properties:output","oasType":"schema","type":"unknown","title":"Output","description":"Output for the job"}
createdstring date-time required

Created timestamp of the job

finishedstring date-time nullable

Finished timestamp of the job

Changes

Changed in 3 of the 123 revisions of this API.237

  • 1af5a8046f202See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 14 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dd3f9cf5f352112See the full diff
    • ▲

      added to the / response property oneOf list for the response status

      response-property-one-of-added

    • ●

      added the new recompute_cluster_title_and_description enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added to the request body anyOf list

      request-body-any-of-added

    • ○

      added recompute_cluster_title_and_description discriminator mapping keys to the / response property for the response status

      response-property-discriminator-mapping-added

  • 53e769440a25123See the full diff
    • ▲

      removed from the request body anyOf list

      request-body-any-of-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property // from the response with the status

      response-optional-property-removed

    • ○

      removed recompute_cluster_title_and_description discriminator mapping keys from the / response property for the response status

      response-property-discriminator-mapping-deleted

    • ○

      removed the recompute_cluster_title_and_description enum value from the / response property for the response status

      response-property-enum-value-removed

    • ○

      removed from the / response property oneOf list for the response status

      response-property-one-of-removed

    This revision also has 34 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog