pandarus/api/progress.json at master · instructure/pandarus · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
{
  "apiVersion": "1.0",
  "swaggerVersion": "1.2",
  "basePath": "https://canvas.instructure.com/api",
  "resourcePath": "/progress",
  "produces": [
    "application/json"
  ],
  "apis": [
    {
      "path": "/v1/progress/{id}",
      "description": "Return completion and status information about an asynchronous job",
      "operations": [
        {
          "method": "GET",
          "summary": "Query progress",
          "notes": "Return completion and status information about an asynchronous job",
          "nickname": "query_progress",
          "parameters": [
            {
              "paramType": "path",
              "name": "id",
              "description": "ID",
              "type": "string",
              "format": null,
              "required": true
            }
          ],
          "type": "Progress"
        }
      ]
    }
  ],
  "models": {
    "Progress": {
      "id": "Progress",
      "description": "",
      "required": [

      ],
      "properties": {
        "id": {
          "description": "the ID of the Progress object",
          "example": 1,
          "type": "integer"
        },
        "context_id": {
          "description": "the context owning the job.",
          "example": 1,
          "type": "integer"
        },
        "context_type": {
          "example": "Account",
          "type": "string"
        },
        "user_id": {
          "description": "the id of the user who started the job",
          "example": 123,
          "type": "integer"
        },
        "tag": {
          "description": "the type of operation",
          "example": "course_batch_update",
          "type": "string"
        },
        "completion": {
          "description": "percent completed",
          "example": 100,
          "type": "integer"
        },
        "workflow_state": {
          "description": "the state of the job one of 'queued', 'running', 'completed', 'failed'",
          "example": "completed",
          "type": "string",
          "allowableValues": {
            "values": [
              "queued",
              "running",
              "completed",
              "failed"
            ]
          }
        },
        "created_at": {
          "description": "the time the job was created",
          "example": "2013-01-15T15:00:00Z",
          "type": "datetime"
        },
        "updated_at": {
          "description": "the time the job was last updated",
          "example": "2013-01-15T15:04:00Z",
          "type": "datetime"
        },
        "message": {
          "description": "optional details about the job",
          "example": "17 courses processed",
          "type": "string"
        },
        "url": {
          "description": "url where a progress update can be retrieved",
          "example": "https://canvas.example.edu/api/v1/progress/1",
          "type": "string"
        }
      }
    }
  }
}