Collaboration Requests | TSANet Connect

Get collaboration requests

get

Authorizations

Query parameters

internalCaseNumberstringOptional

Your internal case number

typestringOptional

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

statusstringOptional

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

updatedAfterstring · date-timeOptional

Filter by collaboration requests that were updated after (YYYY-MM-DDTHH:MM:SSZ) when paginated is false

createdAfterstring · date-timeOptional

Filter by collaboration requests that were created after (YYYY-MM-DDTHH:MM:SSZ) when paginated is false

includeRemovedNotesbooleanOptional

Filter to include removed notes - excluded by default

Default: false

pageinteger · int32Optional

Page number (0-based) for pagination when paginated is true

Default: 0

sizeinteger · int32Optional

Page size for pagination when paginated is true (0 means return all records)

Default: 0

paginatedbooleanOptional

Set to 'true' to request paginated results instead of an array. If true, the updatedAfter and createdAfter filters are ignored.

Default: false

Responses

200

List of collaboration requests or paginated response

Responseobject

401

Unauthorized

get

/v1/collaboration-requests

GET /v1/collaboration-requests HTTP/1.1
Host: connect2.tsanet.org
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{}

Create a new collaboration request

post

Authorizations

Body

documentIdinteger · int64Optional

internalCaseNumberstringOptional

receiverInternalCaseNumberstringOptional

problemSummarystringOptional

problemDescriptionstringOptional

prioritystring · enumOptionalPossible values:

adminNotestringOptional

escalationInstructionsstringOptional

testSubmissionbooleanOptional

Responses

200

Collaboration request created successfully

400

Bad request

401

Unauthorized

403

Access denied

post

/v1/collaboration-requests

POST /v1/collaboration-requests HTTP/1.1
Host: connect2.tsanet.org
Authorization: Bearer YOUR_SECRET_TOKEN
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": "2025-10-28T10:12:08.773Z",
  "updatedAt": "2025-10-28T10:12:08.773Z",
  "deletedAt": "2025-10-28T10:12:08.773Z",
  "responded": true,
  "respondBy": "2025-10-28T10:12:08.773Z",
  "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"
  },
  "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": "2025-10-28T10:12:08.773Z",
      "updatedAt": "2025-10-28T10:12:08.773Z"
    }
  ],
  "caseResponses": [
    {
      "id": 1,
      "type": "APPROVAL",
      "caseNumber": "text",
      "engineerName": "text",
      "engineerPhone": "text",
      "engineerEmail": "text",
      "nextSteps": "text",
      "createdAt": "2025-10-28T10:12:08.773Z"
    }
  ]
}

Get a specific collaboration request by token

get

Authorizations

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

401

Unauthorized

403

Access denied

404

Collaboration request not found

get

/v1/collaboration-requests/{token}

GET /v1/collaboration-requests/{token} HTTP/1.1
Host: connect2.tsanet.org
Authorization: Bearer YOUR_SECRET_TOKEN
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": "2025-10-28T10:12:08.773Z",
  "updatedAt": "2025-10-28T10:12:08.773Z",
  "deletedAt": "2025-10-28T10:12:08.773Z",
  "responded": true,
  "respondBy": "2025-10-28T10:12:08.773Z",
  "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"
  },
  "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": "2025-10-28T10:12:08.773Z",
      "updatedAt": "2025-10-28T10:12:08.773Z"
    }
  ],
  "caseResponses": [
    {
      "id": 1,
      "type": "APPROVAL",
      "caseNumber": "text",
      "engineerName": "text",
      "engineerPhone": "text",
      "engineerEmail": "text",
      "nextSteps": "text",
      "createdAt": "2025-10-28T10:12:08.773Z"
    }
  ]
}

Update collaboration request submitter details

patch

Authorizations

Path parameters

tokenstringRequired

The token provided by TSANet for the collaboration request

Body

internalCaseNumberstringOptional

Internal case number for the submitter's tracking system

Responses

200

Collaboration request updated successfully

400

Bad request

401

Unauthorized

403

Access denied - only the submitter can update these details

404

Collaboration request not found

patch

/v1/collaboration-requests/{token}

PATCH /v1/collaboration-requests/{token} HTTP/1.1
Host: connect2.tsanet.org
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

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

{
  "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": "2025-10-28T10:12:08.773Z",
  "updatedAt": "2025-10-28T10:12:08.773Z",
  "deletedAt": "2025-10-28T10:12:08.773Z",
  "responded": true,
  "respondBy": "2025-10-28T10:12:08.773Z",
  "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"
  },
  "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": "2025-10-28T10:12:08.773Z",
      "updatedAt": "2025-10-28T10:12:08.773Z"
    }
  ],
  "caseResponses": [
    {
      "id": 1,
      "type": "APPROVAL",
      "caseNumber": "text",
      "engineerName": "text",
      "engineerPhone": "text",
      "engineerEmail": "text",
      "nextSteps": "text",
      "createdAt": "2025-10-28T10:12:08.773Z"
    }
  ]
}