{"type":"api","title":"History Status","meta":{"id":"/apps/pubhub/media/edm-api-v2/a2a30bcc9ecab5281b65761ae61df7e0031d5691/f67a4e01-0023-334a-9a4a-7e606c2ef1a2","swagger":"2.0","info":{"contact":{"email":"devmgmt@cisco.com"},"description":"This is the IoT device management core service. The service is responsible for managing the lifecycle of various IoT gateways and endpoints deployed as part of the Field Area Networks","license":{"name":"Licensing is primarily subscription based. Call Andy now!","url":"https://www.cisco.com"},"termsOfService":"http://swagger.io/terms/","title":"IoT Device Lifecycle Management","version":"4.0.0"},"host":"us.ciscoiot.com","basePath":"/nbapi/edm/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"description":"This is the bearer Auth token.","in":"header","name":"Authorization","type":"apiKey"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"}}},"spec":{"description":"Returns a list of current/historical jobs based on a job-type during csv upload of devices (in a paginated way) \u003cbr /\u003e One of the below permissions is needed to invoke this API\u003cbr /\u003e- Tenant Management\u003cbr /\u003e- Manage Devices","operationId":"historyStatus","parameters":[{"description":"The uuid of the tenant in whose context we are calling the api.","format":"uuid","in":"header","name":"x-tenant-id","required":true,"type":"string"},{"description":"The type criteria based on which job-list to return","in":"query","name":"type","required":true,"type":"string"},{"default":0,"description":"particular page number to return","in":"query","minimum":0,"name":"page","required":false,"type":"integer"},{"default":20,"description":"The numbers of items to return","in":"query","maximum":200,"minimum":1,"name":"size","required":false,"type":"integer"},{"default":"desc","description":"order to sorting the retrieved records","in":"query","name":"sort_order","required":false,"type":"string"},{"description":"sort criteria for retrieved records","in":"query","name":"sort_by","required":false,"type":"string"},{"description":"filter query for templates search. Expected values - “fileName:\u003cvalue\u003e user:\u003cvalue\u003e status:\u003cvalue\u003e”","in":"query","name":"filter","required":false,"type":"string"},{"description":"search criteria can be a regular string","in":"query","name":"search","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"successful retrieval","schema":{"properties":{"jobList":{"description":"list of current/historical data for job logs retrieved based on query","items":{"properties":{"failureCount":{"example":0,"type":"integer"},"fileName":{"example":"router2.csv","type":"string"},"jobId":{"example":7126547186,"format":"int64","type":"integer"},"status":{"example":"failed","type":"string"},"submittedAt":{"example":"2021-12-07 08:22","type":"string"},"successCount":{"example":1,"type":"integer"},"totalrecords":{"example":1,"type":"integer"},"type":{"example":"Add Device","type":"string"},"updatedAt":{"example":"2021-12-07 08:22","type":"string"},"user":{"example":"mytestmail@cisco.com","type":"string"}},"type":"object","$$ref":"#/definitions/JobDetail"},"type":"array"},"limit":{"description":"Count of items to be returned in a single page (as given in input)","example":20,"type":"integer"},"totalJobCount":{"description":"The total count of devices returned by query","example":1,"format":"int64","type":"integer"},"totalPages":{"description":"Total numbers of pages to display","example":1,"format":"int64","type":"integer"}},"type":"object","$$ref":"#/definitions/HistoricalJobslistPageInfo"}},"400":{"description":"Bad request","schema":{"description":"Specifies the error that occurred during the jobs api request.","example":{"code":39,"message":"Unable to retrieve jobs based on given query: invalid query passed with query params: Type=Add Device Offset=0 PageLimit=20","meta":null},"type":"object","$$ref":"#/definitions/JobError"}},"401":{"description":"Unauthorized","schema":{"example":"Authentication Token is invalid","type":"string"}},"403":{"description":"Forbidden","schema":{"example":"Permission denied to access the resouce","type":"string"}},"404":{"description":"Not found","schema":{"example":"History not found","type":"string"}},"500":{"description":"Server failure","schema":{"example":"Could not connect to server","type":"string"}}},"summary":"Find list of current and historical jobs data for add devices activity","tags":["jobs"],"__originalOperationId":"historyStatus","security":[{"bearerAuth":[]}],"method":"get","path":"/jobs"}}