Jobs

Schedule a job

Changed on

Create a new job.

post/projects/{owner}/{name}/jobs

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in header x-pollination-token

Path parameters

ownerstring required
namestring required

Headers

authorizationstring
x-pollination-tokenstring

Request body

typestring

A base class to use when there is no baseclass available to fall on.

sourcestring required

The source url for downloading the recipe.

annotationsobject

An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries.

api_versionstring
namestring

An optional name for this job. This name will be used a the display name for the run.

descriptionstring

Run description.

labelsobject

Optional user data as a dictionary. User data is for user reference only and will not be used in the execution of the job.

Response

Successful Response

typestring

A base class to use when there is no baseclass available to fall on.

idstring uuid required

Id for the newly created resource.

messagestring

A human readable message

Example response

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "Use Location in headers to access the new object."
}

Changes

  • e25504ef9dccRevision changes
    • breaking

      response property detail/items/loc/items/ list-of-types was widened by adding types integer to media type application/json of response 422

  • be42c3cf5190Revision changes
    • breaking

      the response's body type changed from no type to object for status

    • warning

      changed the pattern of the request property / from ^Dependency$ to ^Job$

    • info

      the request property default value changed from Dependency to Job

    • info

      added the optional property to the response with the status