Api referenceFindings

Get Finding Collaboration

Reference for Get Finding Collaboration in the Hyperoru v1 API, including request, response, and authentication details.

GET/v1/workspaces/{workspace_id}/findings/{finding_id}/collaboration

Get Finding Collaboration. Returns a typed response and a request ID for operational support.

Authorization

hyperoru_session<token>

Opaque HttpOnly customer session. Mutations also require X-CSRF-Token.

In: cookie

Path Parameters

workspace_id*Workspace Id
Formatuuid
finding_id*Finding Id
Formatuuid

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 GET "https://example.com/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/findings/497f6eca-6276-4993-bfeb-53cbbbba6f08/collaboration"
{
  "attachments": [
    {
      "content_type": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "filename": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "retained_until": "2019-08-24T14:15:22Z",
      "sha256": "string",
      "size_bytes": 0,
      "status": "string",
      "upload_id": "f2ef591b-135b-46fa-a604-3d4fda5bfbfb",
      "uploaded_by": "e134ce2c-a199-4e99-9c11-627b70a7ff28"
    }
  ],
  "collaboration": {
    "assignee_id": "e209ca2d-190b-4818-b659-67d4ef4f1ce8",
    "blocked_reason": "string",
    "due_at": "2019-08-24T14:15:22Z",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "priority": "string",
    "status": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "version": 0
  },
  "current_user_id": "50c4b883-f120-4d9f-8027-c7e77f1adff7",
  "external_issues": [
    {
      "external_id": "string",
      "external_url": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "last_error": "string",
      "last_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "provider": "string",
      "revoked_at": "2019-08-24T14:15:22Z",
      "sync_cursor": "string",
      "sync_state": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workflow_action_id": "7de771d7-f9cd-453f-8427-f366cba180e9"
    }
  ],
  "members": [
    {
      "avatar_url": "string",
      "display_name": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "login": "string",
      "role": "string"
    }
  ],
  "timeline": [
    {
      "actor_id": "04f37679-bfbf-4906-b749-01756515cecf",
      "created_at": "2019-08-24T14:15:22Z",
      "details": {},
      "event_type": "string",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
      "resource_type": "string",
      "version": 0
    }
  ],
  "watchers": [
    {
      "created_at": "2019-08-24T14:15:22Z",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
    }
  ]
}
{
  "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"
}

Download Finding Attachment

Previous Page

Update Finding Collaboration

Next Page