Collaboration Requests

Case creation, retrieval, and management

Create a new collaboration request

post

Authorizations

bearerAuth

Body

application/json

documentIdinteger · int64Required

internalCaseNumberstringRequired

receiverInternalCaseNumberstringOptional

problemSummarystringRequired

problemDescriptionstringRequired

prioritystring · enumRequiredPossible values:

adminNotestringOptional

escalationInstructionsstringOptional

testSubmissionbooleanRequired

Responses

200

Collaboration request created successfully

application/jsonapplication/problem+json

idinteger · int64Optional

submitCompanyNamestringOptional

submitCompanyIdinteger · int64Optional

submitterCaseNumberstringOptional

receiveCompanyNamestringOptional

receiveCompanyIdinteger · int64Optional

receiverCaseNumberstringOptional

summarystringOptional

descriptionstringOptional

directionstring · enumOptionalPossible values:

prioritystring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

tokenstringOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

deletedAtstring · date-timeOptional

respondedbooleanOptional

respondBystring · date-timeOptional

feedbackRequestedbooleanOptional

reminderSentbooleanOptional

priorityNotestringOptional

escalationInstructionsstringOptional

testCasebooleanOptional

400

Bad request

application/jsonapplication/problem+json

401

Unauthorized

application/jsonapplication/problem+json

403

Access denied

application/jsonapplication/problem+json

post

/v1/collaboration-requests

HTTPcURLJavaScriptPython

POST /v1/collaboration-requests HTTP/1.1
Host: connect2.tsanet.org
Content-Type: application/json
Accept: */*
Content-Length: 604

{
  "documentId": 1,
  "internalCaseNumber": "text",
  "receiverInternalCaseNumber": "text",
  "problemSummary": "text",
  "problemDescription": "text",
  "priority": "LOW",
  "adminNote": "text",
  "escalationInstructions": "text",
  "submitterContactDetails": {
    "name": "text",
    "email": "text",
    "phone": "text"
  },
  "customFields": [
    {
      "fieldId": 1,
      "section": "CONTACT_SECTION",
      "label": "text",
      "options": "text",
      "additionalSettings": "text",
      "type": "STRING",
      "displayOrder": 1,
      "validationRules": "text",
      "value": "text",
      "selections": [
        {
          "value": "text",
          "children": [
            "[Circular Reference]"
          ]
        }
      ],
      "required": true
    }
  ],
  "internalNotes": [
    {
      "note": "text"
    }
  ],
  "testSubmission": true
}

{
  "id": 1,
  "submitCompanyName": "text",
  "submitCompanyId": 1,
  "submitterCaseNumber": "text",
  "receiveCompanyName": "text",
  "receiveCompanyId": 1,
  "receiverCaseNumber": "text",
  "summary": "text",
  "description": "text",
  "direction": "OUTBOUND",
  "priority": "LOW",
  "status": "OPEN",
  "token": "text",
  "createdAt": "2026-05-15T20:52:46.951Z",
  "updatedAt": "2026-05-15T20:52:46.951Z",
  "deletedAt": "2026-05-15T20:52:46.951Z",
  "responded": true,
  "respondBy": "2026-05-15T20:52:46.951Z",
  "feedbackRequested": true,
  "reminderSent": true,
  "priorityNote": "text",
  "escalationInstructions": "text",
  "testCase": true,
  "customFields": [
    {
      "id": 1,
      "section": "CONTACT_SECTION",
      "fieldName": "text",
      "value": "text",
      "displayOrder": 1,
      "type": "STRING"
    }
  ],
  "submittedBy": {
    "id": 1,
    "username": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "phone": "text",
    "phoneCountryCode": "text",
    "city": "text",
    "emailCheckFailData": "text"
  },
  "submitterContactDetails": {
    "name": "text",
    "email": "text",
    "phone": "text"
  },
  "receiverContactDetails": {
    "name": "text",
    "email": "text",
    "phone": "text"
  },
  "caseNotes": [
    {
      "id": 1,
      "caseId": 1,
      "companyName": "text",
      "creatorUsername": "text",
      "creatorEmail": "text",
      "creatorName": "text",
      "summary": "text",
      "description": "text",
      "priority": "LOW",
      "status": "ENTERED",
      "token": "text",
      "createdAt": "2026-05-15T20:52:46.951Z",
      "updatedAt": "2026-05-15T20:52:46.951Z"
    }
  ],
  "caseResponses": [
    {
      "id": 1,
      "type": "APPROVAL",
      "caseNumber": "text",
      "engineerName": "text",
      "engineerPhone": "text",
      "engineerEmail": "text",
      "nextSteps": "text",
      "createdAt": "2026-05-15T20:52:46.951Z"
    }
  ]
}

Get a specific collaboration request by token

get

Authorizations

bearerAuth

Path parameters

tokenstringRequired

The token provided by TSANet for the collaboration request

Query parameters

includeRemovedNotesbooleanOptional

Filter to include removed notes - excluded by default

Default: false

Responses

200

Collaboration request details

application/jsonapplication/problem+json

idinteger · int64Optional

submitCompanyNamestringOptional

submitCompanyIdinteger · int64Optional

submitterCaseNumberstringOptional

receiveCompanyNamestringOptional

receiveCompanyIdinteger · int64Optional

receiverCaseNumberstringOptional

summarystringOptional

descriptionstringOptional

directionstring · enumOptionalPossible values:

prioritystring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

tokenstringOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

deletedAtstring · date-timeOptional

respondedbooleanOptional

respondBystring · date-timeOptional

feedbackRequestedbooleanOptional

reminderSentbooleanOptional

priorityNotestringOptional

escalationInstructionsstringOptional

testCasebooleanOptional

401

Unauthorized

application/jsonapplication/problem+json

403

Access denied

application/jsonapplication/problem+json

404

Collaboration request not found

application/jsonapplication/problem+json

get

/v1/collaboration-requests/{token}

HTTPcURLJavaScriptPython

GET /v1/collaboration-requests/{token} HTTP/1.1
Host: connect2.tsanet.org
Accept: */*

{
  "id": 1,
  "submitCompanyName": "text",
  "submitCompanyId": 1,
  "submitterCaseNumber": "text",
  "receiveCompanyName": "text",
  "receiveCompanyId": 1,
  "receiverCaseNumber": "text",
  "summary": "text",
  "description": "text",
  "direction": "OUTBOUND",
  "priority": "LOW",
  "status": "OPEN",
  "token": "text",
  "createdAt": "2026-05-15T20:52:46.951Z",
  "updatedAt": "2026-05-15T20:52:46.951Z",
  "deletedAt": "2026-05-15T20:52:46.951Z",
  "responded": true,
  "respondBy": "2026-05-15T20:52:46.951Z",
  "feedbackRequested": true,
  "reminderSent": true,
  "priorityNote": "text",
  "escalationInstructions": "text",
  "testCase": true,
  "customFields": [
    {
      "id": 1,
      "section": "CONTACT_SECTION",
      "fieldName": "text",
      "value": "text",
      "displayOrder": 1,
      "type": "STRING"
    }
  ],
  "submittedBy": {
    "id": 1,
    "username": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "phone": "text",
    "phoneCountryCode": "text",
    "city": "text",
    "emailCheckFailData": "text"
  },
  "submitterContactDetails": {
    "name": "text",
    "email": "text",
    "phone": "text"
  },
  "receiverContactDetails": {
    "name": "text",
    "email": "text",
    "phone": "text"
  },
  "caseNotes": [
    {
      "id": 1,
      "caseId": 1,
      "companyName": "text",
      "creatorUsername": "text",
      "creatorEmail": "text",
      "creatorName": "text",
      "summary": "text",
      "description": "text",
      "priority": "LOW",
      "status": "ENTERED",
      "token": "text",
      "createdAt": "2026-05-15T20:52:46.951Z",
      "updatedAt": "2026-05-15T20:52:46.951Z"
    }
  ],
  "caseResponses": [
    {
      "id": 1,
      "type": "APPROVAL",
      "caseNumber": "text",
      "engineerName": "text",
      "engineerPhone": "text",
      "engineerEmail": "text",
      "nextSteps": "text",
      "createdAt": "2026-05-15T20:52:46.951Z"
    }
  ]
}

Update collaboration request submitter details

patch

Authorizations

bearerAuth

Path parameters

tokenstringRequired

The token provided by TSANet for the collaboration request

Body

application/merge-patch+jsonapplication/json

Responses

200

Collaboration request updated successfully

application/jsonapplication/problem+json

idinteger · int64Optional

submitCompanyNamestringOptional

submitCompanyIdinteger · int64Optional

submitterCaseNumberstringOptional

receiveCompanyNamestringOptional

receiveCompanyIdinteger · int64Optional

receiverCaseNumberstringOptional

summarystringOptional

descriptionstringOptional

directionstring · enumOptionalPossible values:

prioritystring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

tokenstringOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

deletedAtstring · date-timeOptional

respondedbooleanOptional

respondBystring · date-timeOptional

feedbackRequestedbooleanOptional

reminderSentbooleanOptional

priorityNotestringOptional

escalationInstructionsstringOptional

testCasebooleanOptional

400

Bad request

application/jsonapplication/problem+json

401

Unauthorized

application/jsonapplication/problem+json

403

Access denied - only the submitter can update these details

application/jsonapplication/problem+json

404

Collaboration request not found

application/jsonapplication/problem+json

patch

/v1/collaboration-requests/{token}

HTTPcURLJavaScriptPython

PATCH /v1/collaboration-requests/{token} HTTP/1.1
Host: connect2.tsanet.org
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 111

{
  "internalCaseNumber": {
    "present": true
  },
  "submitterContactDetails": {
    "name": "text",
    "email": "text",
    "phone": "text"
  }
}

application/merge-patch+jsonapplication/json

{
  "id": 1,
  "submitCompanyName": "text",
  "submitCompanyId": 1,
  "submitterCaseNumber": "text",
  "receiveCompanyName": "text",
  "receiveCompanyId": 1,
  "receiverCaseNumber": "text",
  "summary": "text",
  "description": "text",
  "direction": "OUTBOUND",
  "priority": "LOW",
  "status": "OPEN",
  "token": "text",
  "createdAt": "2026-05-15T20:52:46.951Z",
  "updatedAt": "2026-05-15T20:52:46.951Z",
  "deletedAt": "2026-05-15T20:52:46.951Z",
  "responded": true,
  "respondBy": "2026-05-15T20:52:46.951Z",
  "feedbackRequested": true,
  "reminderSent": true,
  "priorityNote": "text",
  "escalationInstructions": "text",
  "testCase": true,
  "customFields": [
    {
      "id": 1,
      "section": "CONTACT_SECTION",
      "fieldName": "text",
      "value": "text",
      "displayOrder": 1,
      "type": "STRING"
    }
  ],
  "submittedBy": {
    "id": 1,
    "username": "text",
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "phone": "text",
    "phoneCountryCode": "text",
    "city": "text",
    "emailCheckFailData": "text"
  },
  "submitterContactDetails": {
    "name": "text",
    "email": "text",
    "phone": "text"
  },
  "receiverContactDetails": {
    "name": "text",
    "email": "text",
    "phone": "text"
  },
  "caseNotes": [
    {
      "id": 1,
      "caseId": 1,
      "companyName": "text",
      "creatorUsername": "text",
      "creatorEmail": "text",
      "creatorName": "text",
      "summary": "text",
      "description": "text",
      "priority": "LOW",
      "status": "ENTERED",
      "token": "text",
      "createdAt": "2026-05-15T20:52:46.951Z",
      "updatedAt": "2026-05-15T20:52:46.951Z"
    }
  ],
  "caseResponses": [
    {
      "id": 1,
      "type": "APPROVAL",
      "caseNumber": "text",
      "engineerName": "text",
      "engineerPhone": "text",
      "engineerEmail": "text",
      "nextSteps": "text",
      "createdAt": "2026-05-15T20:52:46.951Z"
    }
  ]
}

Get collaboration requests (paginated)

get

Authorizations

bearerAuth

Query parameters

internalCaseNumberstringOptional

Your internal case number

typestring · enumOptional

Filter by collaboration request type (optional) - all by default

Default: ALLPossible values:

statusstring · enumOptional

Filter by collaboration request status (optional) - all by default

Default: ALLPossible values:

includeRemovedNotesbooleanOptional

Include removed notes - excluded by default

Default: false

pageinteger · int32Optional

Page number (0-based)

Default: 0

sizeinteger · int32Optional

Page size (0 means return all records)

Default: 25

Responses

200

Paginated list of collaboration requests

application/jsonapplication/problem+json

numberinteger · int32Optional

sizeinteger · int32Optional

totalElementsinteger · int64Optional

totalPagesinteger · int32Optional

firstbooleanOptional

lastbooleanOptional

401

Unauthorized

application/jsonapplication/problem+json

403

Access denied

application/jsonapplication/problem+json

get

/v2/collaboration-requests

HTTPcURLJavaScriptPython

GET /v2/collaboration-requests HTTP/1.1
Host: connect2.tsanet.org
Accept: */*

{
  "content": [
    {
      "id": 1,
      "submitCompanyName": "text",
      "submitCompanyId": 1,
      "submitterCaseNumber": "text",
      "receiveCompanyName": "text",
      "receiveCompanyId": 1,
      "receiverCaseNumber": "text",
      "summary": "text",
      "description": "text",
      "direction": "OUTBOUND",
      "priority": "LOW",
      "status": "OPEN",
      "token": "text",
      "createdAt": "2026-05-15T20:52:46.951Z",
      "updatedAt": "2026-05-15T20:52:46.951Z",
      "deletedAt": "2026-05-15T20:52:46.951Z",
      "responded": true,
      "respondBy": "2026-05-15T20:52:46.951Z",
      "feedbackRequested": true,
      "reminderSent": true,
      "priorityNote": "text",
      "escalationInstructions": "text",
      "testCase": true,
      "customFields": [
        {
          "id": 1,
          "section": "CONTACT_SECTION",
          "fieldName": "text",
          "value": "text",
          "displayOrder": 1,
          "type": "STRING"
        }
      ],
      "submittedBy": {
        "id": 1,
        "username": "text",
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "phone": "text",
        "phoneCountryCode": "text",
        "city": "text",
        "emailCheckFailData": "text"
      },
      "submitterContactDetails": {
        "name": "text",
        "email": "text",
        "phone": "text"
      },
      "receiverContactDetails": {
        "name": "text",
        "email": "text",
        "phone": "text"
      },
      "caseNotes": [
        {
          "id": 1,
          "caseId": 1,
          "companyName": "text",
          "creatorUsername": "text",
          "creatorEmail": "text",
          "creatorName": "text",
          "summary": "text",
          "description": "text",
          "priority": "LOW",
          "status": "ENTERED",
          "token": "text",
          "createdAt": "2026-05-15T20:52:46.951Z",
          "updatedAt": "2026-05-15T20:52:46.951Z"
        }
      ],
      "caseResponses": [
        {
          "id": 1,
          "type": "APPROVAL",
          "caseNumber": "text",
          "engineerName": "text",
          "engineerPhone": "text",
          "engineerEmail": "text",
          "nextSteps": "text",
          "createdAt": "2026-05-15T20:52:46.951Z"
        }
      ]
    }
  ],
  "number": 1,
  "size": 1,
  "totalElements": 1,
  "totalPages": 1,
  "first": true,
  "last": true
}

List collaboration requests

get

Authorizations

bearerAuth

Query parameters

internalCaseNumberstringOptional

Your internal case number

typestring · enumOptional

Filter by collaboration request type (optional) - all by default

Default: ALLPossible values:

statusstring · enumOptional

Filter by collaboration request status (optional) - all by default

Default: ALLPossible values:

updatedAfterstring · date-timeOptional

Filter by requests updated after (YYYY-MM-DDTHH:MM:SSZ)

createdAfterstring · date-timeOptional

Filter by requests created after (YYYY-MM-DDTHH:MM:SSZ)

includeRemovedNotesbooleanOptional

Include removed notes - excluded by default

Default: false

Responses

200

List of collaboration requests

application/jsonapplication/problem+json

idinteger · int64Optional

submitCompanyNamestringOptional

submitCompanyIdinteger · int64Optional

submitterCaseNumberstringOptional

receiveCompanyNamestringOptional

receiveCompanyIdinteger · int64Optional

receiverCaseNumberstringOptional

summarystringOptional

descriptionstringOptional

directionstring · enumOptionalPossible values:

prioritystring · enumOptionalPossible values:

statusstring · enumOptionalPossible values:

tokenstringOptional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

deletedAtstring · date-timeOptional

respondedbooleanOptional

respondBystring · date-timeOptional

feedbackRequestedbooleanOptional

reminderSentbooleanOptional

priorityNotestringOptional

escalationInstructionsstringOptional

testCasebooleanOptional

401

Unauthorized

application/jsonapplication/problem+json

403

Access denied

application/jsonapplication/problem+json

get

/v2/collaboration-requests/list

HTTPcURLJavaScriptPython

GET /v2/collaboration-requests/list HTTP/1.1
Host: connect2.tsanet.org
Accept: */*

[
  {
    "id": 1,
    "submitCompanyName": "text",
    "submitCompanyId": 1,
    "submitterCaseNumber": "text",
    "receiveCompanyName": "text",
    "receiveCompanyId": 1,
    "receiverCaseNumber": "text",
    "summary": "text",
    "description": "text",
    "direction": "OUTBOUND",
    "priority": "LOW",
    "status": "OPEN",
    "token": "text",
    "createdAt": "2026-05-15T20:52:46.951Z",
    "updatedAt": "2026-05-15T20:52:46.951Z",
    "deletedAt": "2026-05-15T20:52:46.951Z",
    "responded": true,
    "respondBy": "2026-05-15T20:52:46.951Z",
    "feedbackRequested": true,
    "reminderSent": true,
    "priorityNote": "text",
    "escalationInstructions": "text",
    "testCase": true,
    "customFields": [
      {
        "id": 1,
        "section": "CONTACT_SECTION",
        "fieldName": "text",
        "value": "text",
        "displayOrder": 1,
        "type": "STRING"
      }
    ],
    "submittedBy": {
      "id": 1,
      "username": "text",
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "phoneCountryCode": "text",
      "city": "text",
      "emailCheckFailData": "text"
    },
    "submitterContactDetails": {
      "name": "text",
      "email": "text",
      "phone": "text"
    },
    "receiverContactDetails": {
      "name": "text",
      "email": "text",
      "phone": "text"
    },
    "caseNotes": [
      {
        "id": 1,
        "caseId": 1,
        "companyName": "text",
        "creatorUsername": "text",
        "creatorEmail": "text",
        "creatorName": "text",
        "summary": "text",
        "description": "text",
        "priority": "LOW",
        "status": "ENTERED",
        "token": "text",
        "createdAt": "2026-05-15T20:52:46.951Z",
        "updatedAt": "2026-05-15T20:52:46.951Z"
      }
    ],
    "caseResponses": [
      {
        "id": 1,
        "type": "APPROVAL",
        "caseNumber": "text",
        "engineerName": "text",
        "engineerPhone": "text",
        "engineerEmail": "text",
        "nextSteps": "text",
        "createdAt": "2026-05-15T20:52:46.951Z"
      }
    ]
  }
]