{"apiVersion":"5.1.1","swaggerVersion":"1.1","basePath":"https://api.composer.nprstations.org/v1","resourcePath":"/job","apis":[{"path":"/job/force","description":"Force Jobs to Run.","operations":[{"parameters":[{"name":"id","description":"Batch/Job ID","dataType":"string","paramType":"query"}],"httpMethod":"GET","notes":"This endpoint is used to force specific jobs or batches of jobs to run. This will be used               when we are testing or need to force a specific set of jobs to run again. This could cause               issues with the Worker process since it might grab jobs that are already in play.","errorResponses":[{"code":400,"reason":"invalid id","errors":[]},{"code":404,"reason":"job not found"},{"code":500,"reason":"server error "}],"nickname":"force","summary":"Execute","customFields":{"description":"Force Jobs to Run.","path":"/job/force","method":"GET","params":[{"name":"id","description":"Batch/Job ID","dataType":"string","paramType":"query"}],"responseClass":"Job","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"Job"}]},{"path":"/job/search","description":"Search","operations":[{"parameters":[{"name":"ucs","description":"UCS ID","dataType":"string","paramType":"query"},{"name":"program","description":"Program ID","dataType":"string","paramType":"query"},{"name":"batch","description":"Batch ID","dataType":"string","paramType":"query"},{"name":"since","description":"Only get jobs newer than this date","dataType":"string","paramType":"query"},{"name":"id","description":"Job ID (Optional)","dataType":"string","paramType":"query"},{"name":"name","description":"Job Name (Defaults to Any)","dataType":"string","required":false,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["any","addPlaylistFile","processPlayListFile","movePlaylist"]},"defaultValue":"any","paramType":"query"},{"name":"status","description":"Job Status (Defaults to Pending)","dataType":"string","required":false,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["any","queued","failed","complete","dequeued"]},"defaultValue":"any","paramType":"query"},{"name":"limit","description":"Number of Jobs to process.","dataType":"string","paramType":"query"}],"httpMethod":"GET","notes":"This endpoint search all job endpoints.","errorResponses":[{"code":400,"reason":"invalid id","errors":[]},{"code":404,"reason":"no results found List[Job]"},{"code":500,"reason":"server error "}],"nickname":"search","summary":"Search","customFields":{"description":"Search","path":"/job/search","method":"GET","params":[{"name":"ucs","description":"UCS ID","dataType":"string","paramType":"query"},{"name":"program","description":"Program ID","dataType":"string","paramType":"query"},{"name":"batch","description":"Batch ID","dataType":"string","paramType":"query"},{"name":"since","description":"Only get jobs newer than this date","dataType":"string","paramType":"query"},{"name":"id","description":"Job ID (Optional)","dataType":"string","paramType":"query"},{"name":"name","description":"Job Name (Defaults to Any)","dataType":"string","required":false,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["any","addPlaylistFile","processPlayListFile","movePlaylist"]},"defaultValue":"any","paramType":"query"},{"name":"status","description":"Job Status (Defaults to Pending)","dataType":"string","required":false,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["any","queued","failed","complete","dequeued"]},"defaultValue":"any","paramType":"query"},{"name":"limit","description":"Number of Jobs to process.","dataType":"string","paramType":"query"}],"responseClass":"List[Job]","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"List[Job]"}]},{"path":"/job/{id}","description":"Get a Job","operations":[{"parameters":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"GET","notes":"This endpoint will return a specific Job. It does not execute the Job. This is intended to provide status information.","errorResponses":[{"code":400,"reason":"invalid id","errors":[]},{"code":404,"reason":"job not found"},{"code":500,"reason":"server error "}],"nickname":"get","summary":"Get","customFields":{"description":"Get a Job","path":"/job/{id}","method":"GET","params":[{"name":"id","description":"UCS ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"responseClass":"Job","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"Job"}]},{"path":"/job/{id}","description":"Update Job","operations":[{"parameters":[{"name":"id","description":"Job ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"body","description":"Job Update Object","dataType":"Job","required":true,"allowMultiple":false,"paramType":"body"}],"httpMethod":"PUT","notes":"This route provides the ability to update a specific job.","errorResponses":[{"code":400,"reason":"invalid id","errors":[]},{"code":404,"reason":"job not found"},{"code":403,"reason":"no permission for Job Update"},{"code":500,"reason":"server error undefined"}],"nickname":"update","summary":"Update","customFields":{"description":"Update Job","path":"/job/{id}","method":"PUT","params":[{"name":"id","description":"Job ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"},{"name":"body","description":"Job Update Object","dataType":"Job","required":true,"allowMultiple":false,"paramType":"body"}],"responseClass":"Job","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"Job"}]},{"path":"/job","description":"Create a Job","operations":[{"parameters":[{"name":"body","description":"Job Object","dataType":"Job","required":true,"allowMultiple":false,"paramType":"body"}],"httpMethod":"POST","notes":"This route provides the ability to create a Job.","errorResponses":[{"code":500,"reason":"server error undefined"},{"code":403,"reason":"no permission for UCS Created"},{"code":400,"reason":"invalid Invalid Data","errors":[]}],"nickname":"create","summary":"Create","customFields":{"description":"Create a Job","path":"/job","method":"POST","params":[{"name":"body","description":"Job Object","dataType":"Job","required":true,"allowMultiple":false,"paramType":"body"}],"responseClass":"Job","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"Job"}]},{"path":"/job/{id}","description":"Delete a Job","operations":[{"parameters":[{"name":"id","description":"Job ID (or IDs)","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"DELETE","notes":"This route provides the ability to delete a Job.","errorResponses":[{"code":400,"reason":"invalid id","errors":[]},{"code":404,"reason":"ucs not found"},{"code":403,"reason":"no permission for Job Delete"},{"code":500,"reason":"server error "}],"nickname":"delete","summary":"Delete","customFields":{"description":"Delete a Job","path":"/job/{id}","method":"DELETE","params":[{"name":"id","description":"Job ID (or IDs)","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"responseClass":"Job","preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"Job"}]}],"models":{"Job":{"id":"Job","properties":{"type":{"type":"string","description":"The kind of grant.","required":true},"ucs":{"type":"string","description":"UCS Owner.","required":true},"name":{"type":"string","description":"Name of the Job.","required":true},"priority":{"type":"integer","description":"Job Priority 1 (Highest) to 5 (Lowest)","required":true}}}}}