Api referenceWorkspaces
Request Workflow Action
Reference for Request Workflow Action in the Hyperoru v1 API, including request, response, and authentication details.
POST
/v1/workspaces/{workspace_id}/workflow-actionsRequest Workflow Action. Returns a typed response and a request ID for operational support.
hyperoru_session<token>
Opaque HttpOnly customer session. Mutations also require X-CSRF-Token.
In: cookie
Path Parameters
workspace_id*Workspace Id
Format
uuidHeader Parameters
Idempotency-Key*Idempotency-Key
Length
8 <= length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/workflow-actions" \ -H "Idempotency-Key: stringst" \ -H "Content-Type: application/json" \ -d '{ "authorization_id": "be63c26c-03c0-4635-ae2b-58f14bd033f9", "capability": "ticket_creation", "target_id": "d3bcdc92-4191-401b-ad0c-42056c6efab9" }'{
"approved_at": "2019-08-24T14:15:22Z",
"approved_by": "02030314-b162-4b4d-8af1-88eabdcc615d",
"attempts": 0,
"authorization_id": "be63c26c-03c0-4635-ae2b-58f14bd033f9",
"capability": "ticket_creation",
"created_at": "2019-08-24T14:15:22Z",
"decision_reason": "string",
"error_code": "string",
"executed_at": "2019-08-24T14:15:22Z",
"external_id": "string",
"external_url": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"request_payload": {},
"requested_by": "cda0f200-65cd-4343-aedd-9c936b908826",
"status": "string",
"target_id": "d3bcdc92-4191-401b-ad0c-42056c6efab9",
"target_type": "finding",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}{
"code": "validation_failed",
"detail": "The request body did not match the documented schema.",
"instance": "/v1/audits",
"request_id": "018f6f5d-36a2-7a2d-a8f6-ec1a55c03e45",
"status": 422,
"title": "Validation Failed",
"type": "https://api.hyperoru.com/problems/validation_failed"
}