Offering instances
A list of instances for the offering are described in this topic.
Instances
GET: Lists offerings
- URL pattern
- /orchestrator/v2/offerings
- Accepts
- *
- Content-Type
- application/JSON
- Normal Response Codes
- 200 OK
- Error Response Codes
- 401 unauthorized
- 500 internal server error
- Response
- Offerings Response
- Search Attributes
- Name, description
- Filter Attributes
- id, name, description, icon, human_service, human_service_app_id, priority, created, updated, process, process_app_id, owner_id, category, implementation_type, operation_type, instancetype
- Authorization
- role: admin or ACL with 'view' set to 'true' for given domain, project, and role
POST: Creates an offering
- URL pattern
- /orchestrator/v2/offerings
- Accepts
- application/JSON
- Content-Type
- application/JSON
- Normal Response Codes
- 201 created
- Error Response Codes
- 400 bad request if bad JSON was passed or mandatory attributes were missing
- 401 unauthorized
- 500 internal server error
- Request
- Offering Request
- Response
- Offering Response
- Authorization
- roles: "admin", "domain_admin"
POST: Creates an offering
- URL pattern
- /orchestrator/v2/offerings
- Accepts
- application/JSON
- Content-Type
- application/JSON
- Normal Response Codes
- 201 created
- Error Response Codes
- 400 bad request if bad JSON was passed or mandatory attributes were missing
- 401 unauthorized
- 500 internal server error
- Request
- Offering Request
- Response
- Offering Response
- Authorization
- roles: "admin", "domain_admin"
GET: Get an offering
- URL pattern
- /orchestrator/v2/offerings/{id}
- Accepts
- *
- Content-Type
- application/JSON
- Normal Response Codes
- 200 OK
- Error Response Codes
- 401 unauthorized
- 404 not found
- 500 internal server error
- Response
- Offering Response
- Authorization
- role: admin or ACL with 'view' set to 'true' for given domain, project, and role
PUT: Update an offering
- URL pattern
- /orchestrator/v2/offerings/{id}
- Accepts
- application/JSON
- Content-Type
- application/JSON
- Normal Response Codes
- 200 OK
- Error Response Codes
- 400 bad request if bad JSON was passed
- 401 unauthorized
- 404 not found
- 500 internal server error
- Request
- Offering Request (partial)
- Response
- Offering Response
- Authorization
- role: admin or ACL with 'modify' set to 'true' for given domain, project, and role
DELETE: Delete an offering
- URL pattern
- /orchestrator/v2/offerings/{id}
- Accepts
- *
- Normal Response Codes
- 204 no content
- Error Response Codes
- 401 unauthorized
- 500 internal server error
- Authorization
- role: admin or ACL with 'modify' set to 'true' for given domain, project, and role
POST: Execute an offering
- URL pattern
- /orchestrator/v2/offerings/{id}/launch
- Accepts
- application/JSON
- Content-Type
- application/JSON
- Normal Response Codes
- 202 accepted
- Error Response Codes
- 400 bad request if bad JSON was passed
- 401 unauthorized
- 404 not found
- 500 internal server error
- Request
- Go to Launching an offering via offering API
- Response
- TaskResponse
- Authorization
- role: admin or ACL with 'use' set to 'true' for given domain, project, and role
GET: Get ACL entries for a given offering
- URL pattern
- /orchestrator/v2/offerings/{id}/acl
- Accepts
- *
- Content-Type
- application/JSON
- Normal Response Codes
- 200 OK
- Error Response Codes
- 401 unauthorized
- 404 not found
- 500 internal server error
- Response
- ACLs Response
- Authorization
- No authorization is needed but the result is restricted for the given domain, project, and role of the user
PUT: Update given acl for a given offering
- URL pattern
- /orchestrator/v2/offerings/{id}/acl
- Accepts
- application/JSON
- Content-Type
- application/JSON
- Normal Response Codes
- 200
- Error Response Codes
- 400 bad request of bas JSON was passed
- 401 unauthorized
- 404 not found
- 500 internal server error
- Request
- ACLs Request
- Response
- ACLS Response
- Authorization
- No authorization is needed but the given ACL is adjusted to the given domain, project, and role of the user
GET: Get input parameters for a given offering
- URL pattern
- /orchestrator/v2/offerings/{id}/parameters
- Accepts
- *
- Content-Type
- application/JSON
- Normal Response Codes
- 200 OK
- Error Response Codes
- 401 unauthorized
- 404 not found
- 500 internal server error
- Response
- Parameters Response
- Authorization
- No authorization is needed but the result is restricted for the given domain, project, and role of the user
GET: Get graphical representation of a given offering workflow
- URL pattern
- /orchestrator/v2/offerings/{id}/graph
- Accepts
- *
- Content-Type
- application/JSON
- Normal Response Codes
- 200 OK
- Error Response Codes
- 401 unauthorized
- 404 not found
- 500 internal server error
- Response
- image/jpeg binary image representing this offering's workflow
- Authorization
- No authorization is needed but the result is restricted for the given domain, project, and role of the user