Get Customer Deals by ID - Cloud Security API

{"type":"api","title":"Get Customer Deals by ID","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/77649db0-b5f6-3157-b85b-a889624baad4","info":{"title":"Cisco Umbrella Providers API","version":"2.0.0","description":"Manage the customers for a provider.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Providers"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/admin/providers-overview.md","uri":"umbrella-api-reference-providers-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"admin.customers:read":"Read admin customers","admin.customers:write":"Write admin customers","admin.customerSearch:read":"Read admin customer search","admin.customerDeals:read":"Read admin customer deals","admin.customerDeals:write":"Write admin customer deals"}}}}}},"spec":{"tags":["Providers","Umbrella"],"description":"Get the information about deals available to customer.","summary":"Get Customer Deals by ID","operationId":"getCustomerDeals","parameters":[{"name":"dealId","in":"path","description":"The deal ID.","required":true,"schema":{"type":"string"},"example":"1235a","$$ref":"#/components/parameters/dealIdParam"},{"name":"ccoId","in":"query","description":"The ID of the user querying the deal ID.","required":true,"schema":{"type":"integer","format":"int32"},"example":12329433,"$$ref":"#/components/parameters/ccoIdParam"}],"security":[{"oauthFlow":["admin.customerDeals:read"]}],"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"The information about a customer deal.","required":["dealId","endCustomer","majorLineItems","canStampDeal","trialIds"],"properties":{"dealId":{"type":"string","description":"The deal ID.","example":"14a","$$ref":"#/components/schemas/dealId"},"endCustomer":{"type":"string","description":"The type of customer.","example":""},"majorLineItems":{"type":"array","description":"The list of essential components of the deal.","items":{"type":"object","properties":{"objectId":{"type":"integer","description":"The ID of the object.","example":123545},"sourceAppRefId":{"type":"string","description":"The source application reference ID.","example":"abbfyue458cjd"}}},"example":[{"objectId":123455,"sourceAppRefId":"asdfkljdkjfklj"}]},"canStampDeal":{"type":"boolean","description":"Specify whether to approve the deal.","example":false},"trialIds":{"type":"array","description":"The list of trial IDs.","items":{"type":"string"},"example":["abbfyue458cjd"]}},"example":{"dealId":"1233456","endCustomer":"","majorLineItems":[{"objectId":12345345,"sourceAppRefId":"abdjlkjfkj22"}],"canStampDeal":true,"trialIds":["abbfyue458cjd"]},"$$ref":"#/components/schemas/CustomerDeal"}},"example":[{"dealId":"1233456a","endCustomer":"","majorLineItems":[{"objectId":12345345,"sourceAppRefId":"abdjlkjfkj22"}],"canStampDeal":true,"trialIds":["abbfyue458cjd"]}]}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Message for Invalid request","properties":{"message":{"type":"string","description":"Message for Invalid request"}}},"example":{"message":"Invalid request"}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Unauthorized request","properties":{"message":{"type":"string","description":"Message for Unauthorized request"}}},"example":{"message":"Unauthorized request"}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Message for Forbidden","properties":{"message":{"type":"string","description":"Message for Forbidden"}}},"example":{"message":"Forbidden"}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Message for Not Found","properties":{"message":{"type":"string","description":"Message for Not Found"}}},"example":{"message":"Not Found"}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","format":"iso-date-time"},"description":"The date and time of the request that is represented in ISO 8601 format.\nThe timestamp uses Greenwich Mean Time (GMT).","example":"Date: Mon, 18 Apr 2022 11:11:11 GMT","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"Message for Server error","properties":{"message":{"type":"string","description":"Message for Server error"}}},"example":{"message":"server error"}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getCustomerDeals","method":"get","path":"/providers/customerDeals/{dealId}"}}