Retrieve a System Job Template

get

/api/v2/system_job_templates/{id}/

Make GET request to this resource to retrieve a single system job template record containing the following fields:

  • id: Database ID for this system job template. (integer)
  • type: Data type for this system job template. (choice)
  • url: URL for this system job template. (string)
  • related: Data structure with URLs of related resources. (object)
  • summary_fields: Data structure with name/description for related resources. The output for some objects may be limited for performance reasons. (object)
  • created: Timestamp when this system job template was created. (datetime)
  • modified: Timestamp when this system job template was last modified. (datetime)
  • name: Name of this system job template. (string)
  • description: Optional description of this system job template. (string)
  • last_job_run: (datetime)
  • last_job_failed: (boolean)
  • next_job_run: (datetime)
  • status: (choice)
    • new: New
    • pending: Pending
    • waiting: Waiting
    • running: Running
    • successful: Successful
    • failed: Failed
    • error: Error
    • canceled: Canceled
    • never updated: Never Updated
    • ok: OK
    • missing: Missing
    • none: No External Source
    • updating: Updating
  • execution_environment: The container image to be used for execution. (id)
  • job_type: (choice)
    • "": ---------
    • cleanup_jobs: Remove jobs older than a certain number of days
    • cleanup_activitystream: Remove activity stream entries older than a certain number of days
    • cleanup_sessions: Removes expired browser sessions from the database
    • cleanup_tokens: Removes expired OAuth 2 access tokens and refresh tokens

Request

Supported Media Types
Path Parameters
Query Parameters
Back to Top

Response

200 Response

Back to Top