{"apiVersion":"5.1.1","swaggerVersion":"1.1","basePath":"https://api.composer.nprstations.org/v1","resourcePath":"/batch","apis":[{"path":"/batch/search","description":"This endpoint will search BatchDetails documents.","operations":[{"parameters":[{"name":"type","description":"The type of batch that is being searched for.  Required.","dataType":"string","required":true,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["sxExport"," playlistImport"," syndication"]},"defaultValue":null,"paramType":"query"},{"name":"sort","description":"Sort the search results, asc (ascending) or desc (descending) by the date of batch creation.  Default: desc.","dataType":"string","required":false,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["asc"," desc"]},"defaultValue":"desc","paramType":"query"},{"name":"limit","description":"Maximum number of documents to return.  Default: 5.","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"5","paramType":"query"}],"httpMethod":"GET","errorResponses":[{"code":404,"reason":"no results found List[BatchDetails]"},{"code":500,"reason":"server error "}],"nickname":"batchSearch","customFields":{"path":"/batch/search","method":"GET","description":"This endpoint will search BatchDetails documents.","params":[{"name":"type","description":"The type of batch that is being searched for.  Required.","dataType":"string","required":true,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["sxExport"," playlistImport"," syndication"]},"defaultValue":null,"paramType":"query"},{"name":"sort","description":"Sort the search results, asc (ascending) or desc (descending) by the date of batch creation.  Default: desc.","dataType":"string","required":false,"allowMultiple":false,"allowableValues":{"valueType":"LIST","values":["asc"," desc"]},"defaultValue":"desc","paramType":"query"},{"name":"limit","description":"Maximum number of documents to return.  Default: 5.","dataType":"string","required":false,"allowMultiple":false,"allowableValues":null,"defaultValue":"5","paramType":"query"}],"preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"void"}]},{"path":"/batch/{id}/cancel","description":"This endpoint will cancel a batch by cancelling each of queued jobs.  It will NOT cancel in-progress or already completed/failed jobs.","operations":[{"parameters":[{"name":"id","description":"Batch ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"GET","errorResponses":[{"code":404,"reason":"no results found List[BatchDetails]"},{"code":500,"reason":"server error "}],"nickname":"batchCancel","customFields":{"path":"/batch/{id}/cancel","method":"GET","description":"This endpoint will cancel a batch by cancelling each of queued jobs.  It will NOT cancel in-progress or already completed/failed jobs.","params":[{"name":"id","description":"Batch ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"void"}]},{"path":"/batch/{id}","description":"This endpoint will search BatchDetails documents.","operations":[{"parameters":[{"name":"id","description":"Batch ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"httpMethod":"GET","errorResponses":[{"code":404,"reason":"no results found List[BatchDetails]"},{"code":500,"reason":"server error "}],"nickname":"batchSearch","customFields":{"path":"/batch/{id}","method":"GET","description":"This endpoint will search BatchDetails documents.","params":[{"name":"id","description":"Batch ID","dataType":"string","required":true,"allowMultiple":false,"paramType":"path"}],"preliminaryCallbacks":[null],"requestSignature":"token"},"responseClass":"void"}]}],"models":{}}