HEhere
Manage Jobs

Create Job

Changed on
post/jobs

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /jobs
  • Auth
    • API key in query parameter access_token
    • or HTTP bearer

Request body

typestring

The type of the job (deprecated)

idstring

The unique identifier of the job. NOTE: The id will always be generated by the service. It can not be defined by the client.

descriptionstring

A human readable description of the purpose of the job

Example request

{
  "description": "This job exports some data from my space into GeoJSON files",
  "source": {
    "type": "Space",
    "id": "sdkeuh7"
  },
  "target": {
    "type": "Files"
  }
}

Response

The Job

typestring

The type of the job (deprecated)

idstring

The unique identifier of the job. NOTE: The id will always be generated by the service. It can not be defined by the client.

descriptionstring

A human readable description of the purpose of the job

Example response

{
  "description": "This job exports some data from my space into GeoJSON files",
  "source": {
    "type": "Space",
    "id": "sdkeuh7"
  },
  "target": {
    "type": "Files"
  }
}

Changes

  • 88b5563c7e8bRevision changes
    • info

      added the non-success response with the status

  • 43ba9f3769d9Revision changes
    • info

      added the new optional request property ////////

    • info

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