{"swagger":"2.0","info":{"description":"Provides PUBLIC API functionality","version":"1.0.0","title":"Agile Documents API - DEV","contact":{"email":"JNadrowski@blueclarity.com"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"tags":[{"name":"admins","description":"Secured admin-only calls"},{"name":"developers","description":"Operations available to regular developers"}],"paths":{"/GetTaskStatus":{"get":{"tags":["developers"],"summary":"Get task information","operationId":"getTaskStatus","description":"By passing in the appropriate options, you can retrieve task information from the system\n","produces":["application/json"],"parameters":[{"in":"query","name":"APIKey","description":"your assigned API Key","required":true,"type":"string"},{"in":"query","name":"APIPassword","description":"your assigned API Password","required":true,"type":"string"},{"in":"query","name":"TaskGUID","description":"The Task GUID to lookup","required":true,"type":"string"}],"responses":{"200":{"description":"task results matching criteria","schema":{"$ref":"#/definitions/TaskStatus"}},"404":{"description":"invalid parameter(s)"},"500":{"description":"exception"}}}},"/BuildWithURI":{"post":{"tags":["developers"],"summary":"Queues a build","operationId":"queueAgileDocumentBuild","description":"Queues an Agile Document to be built","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"query","name":"APIKey","description":"your assigned API Key","required":true,"type":"string"},{"in":"query","name":"APIPassword","description":"your assigned API Password","required":true,"type":"string"},{"in":"body","name":"AgileDocumentData","description":"Data that specifies the Agile Document and optionally data to augment the Agile Document build process.","required":true,"schema":{"$ref":"#/definitions/AgileDocumentDataItem"}}],"responses":{"200":{"description":"results from the queue request","schema":{"$ref":"#/definitions/BuildRequestResultItem"}},"403":{"description":"your license does not support this feature"},"404":{"description":"invalid parameter(s)"},"500":{"description":"exception"}}}}},"definitions":{"AgileDocumentDataItem":{"type":"object","required":["uri"],"properties":{"uri":{"type":"string","format":"url","example":"https://blueclarity.sharepoint.com/sites/site1/ADExamples/Word/EX1/EX1.AgileDocument.xml"}}},"BuildRequestResultItem":{"type":"object","required":["task","AgileDocument"],"properties":{"task":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851"},"AgileDocument":{"type":"string","format":"url","example":"https://blueclarity.sharepoint.com/sites/site1/ADExamples/Word/EX1/EX1.AgileDocument.xml"}}},"TaskStatus":{"type":"object","required":["TaskID","Queued"],"properties":{"TaskID":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851"},"Queued":{"type":"string","format":"date-time","example":"2016-08-29T09:12:33.001"},"PercentComplete":{"type":"string","format":"float","example":100.0},"Started":{"type":"string","format":"date-time","example":"2016-08-29T09:12:33.001"},"LastServerUpdate":{"type":"string","format":"date-time","example":"2016-08-29T09:12:33.001"},"IsException":{"type":"boolean","example":false},"IsCompleted":{"type":"boolean","example":true},"Outputs":{"type":"array","items":{"$ref":"#/definitions/OutputItem"}}}},"OutputItem":{"required":["ListItemURI"],"properties":{"Created":{"type":"string","format":"date-time","example":"2016-08-29T09:12:33.001"},"ListItemURI":{"type":"string","format":"url","example":"https://blueclarity.sharepoint.com/sites/site1/ADExamples/Word/EX1/EX1.DOCX"},"ListItemINT":{"type":"integer","format":"int32","example":15},"ParentList":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851"},"ParentWeb":{"type":"string","format":"url","example":"https://blueclarity.sharepoint.com/sites/site1"}}}},"host":"agiledocweb-dev.azurewebsites.net","basePath":"/AgileDocuments/api/agiledocuments","schemes":["https"]}