{
  "opencollection": "1.0.0",
  "info": {
    "name": "Appen Platform Account Info Job Status API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Job Status",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get job attributes.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.appen.com/v1/jobs/:job_id.json",
            "params": [
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a job or task that is distributed to contributors. Variable name: `{job_id}`. \n"
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "Your personal Appen API key; used to access the Appen platform. Can be found in your [account settings](https://client.appen.com/account/api). Variable name: `{api_key}`. \n"
              }
            ]
          },
          "docs": "Gets the .json of the Job identified by the job_id parameter of the\nrequest. This includes the total cost and job state.\n"
        },
        {
          "info": {
            "name": "Launch a job.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.appen.com/v1/jobs/:job_id/orders.json",
            "params": [
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a job or task that is distributed to contributors. Variable name: `{job_id}`. \n"
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "Your personal Appen API key; used to access the Appen platform. Can be found in your [account settings](https://client.appen.com/account/api). Variable name: `{api_key}`. \n"
              },
              {
                "name": "channel_id",
                "value": "",
                "type": "query",
                "description": "A unique identifier for a group of contributors. Variable name: `{channel_id}`. \n"
              },
              {
                "name": "debit[units_count]",
                "value": "",
                "type": "query",
                "description": "The number of rows to be launched"
              }
            ]
          },
          "docs": "Launch a job."
        },
        {
          "info": {
            "name": "Pause a job.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.appen.com/v1/jobs/:job_id/pause.json",
            "params": [
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a job or task that is distributed to contributors. Variable name: `{job_id}`. \n"
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "Your personal Appen API key; used to access the Appen platform. Can be found in your [account settings](https://client.appen.com/account/api). Variable name: `{api_key}`. \n"
              }
            ]
          },
          "docs": "Pause a Job that is currently running."
        },
        {
          "info": {
            "name": "Resume a job.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.appen.com/v1/jobs/:job_id/resume.json",
            "params": [
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a job or task that is distributed to contributors. Variable name: `{job_id}`. \n"
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "Your personal Appen API key; used to access the Appen platform. Can be found in your [account settings](https://client.appen.com/account/api). Variable name: `{api_key}`. \n"
              }
            ]
          },
          "docs": "Resume a job that had been paused."
        },
        {
          "info": {
            "name": "Cancel a job.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.appen.com/v1/jobs/:job_id/cancel.json",
            "params": [
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a job or task that is distributed to contributors. Variable name: `{job_id}`. \n"
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "Your personal Appen API key; used to access the Appen platform. Can be found in your [account settings](https://client.appen.com/account/api). Variable name: `{api_key}`. \n"
              }
            ]
          },
          "docs": "Cancels a job."
        },
        {
          "info": {
            "name": "Get the status of a job.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.appen.com/v1/jobs/:job_id/ping.json",
            "params": [
              {
                "name": "job_id",
                "value": "",
                "type": "path",
                "description": "A unique identifier for a job or task that is distributed to contributors. Variable name: `{job_id}`. \n"
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "Your personal Appen API key; used to access the Appen platform. Can be found in your [account settings](https://client.appen.com/account/api). Variable name: `{api_key}`. \n"
              }
            ]
          },
          "docs": "Get the Status of a Job (includes Unit and Judgment counts)."
        }
      ]
    }
  ],
  "bundled": true
}