UHuhh-lt
perspectives

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

Changed on
post/perspectives/job/{aspect_id}

Request

  • The document declares no server URL.
  • Auth
    OAuth 2
    Password
    Token URL: /authentication/login

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_type'perspectives' 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

outputunknown
createdstring date-time required

Created timestamp of the job

finishedstring date-time nullable

Finished timestamp of the job

Changes

  • 753207b3f495Revision changes
    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • breaking

      the request property / became required

    • info

      the request property default value add_missing_docs_to_aspect was removed

    • info

      the request property default value change_cluster was removed

    • info

      the request property default value create_cluster_with_name was removed

    • info

      the request property default value create_cluster_with_sdocs was removed

    • info

      the request property default value merge_clusters was removed

    • info

      the request property default value recompute_cluster_title_and_description was removed

    • info

      the request property default value refine_model was removed

    • info

      the request property default value remove_cluster was removed

    • info

      the request property default value reset_model was removed

    • info

      the request property default value split_cluster was removed

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response's property default value add_missing_docs_to_aspect was removed for the status

    • info

      the response's property default value change_cluster was removed for the status

    • info

      the response's property default value create_aspect was removed for the status

    • info

      the response's property default value create_cluster_with_name was removed for the status

    • info

      the response's property default value create_cluster_with_sdocs was removed for the status

    • info

      the response's property default value merge_clusters was removed for the status

    • info

      the response's property default value recompute_cluster_title_and_description was removed for the status

    • info

      the response's property default value refine_model was removed for the status

    • info

      the response's property default value remove_cluster was removed for the status

    • info

      the response's property default value reset_model was removed for the status

    • info

      the response's property default value split_cluster was removed for the status

  • 3bdfd02830b1Revision changes
    • warning

      added the new perspectives enum value to the response property for the response status

    • info

      the response property const value perspectives was added for the status