Collaboration Requests

Case creation, retrieval, and management

Create a new collaboration request

post
Authorizations
Body
documentIdinteger · int64Required
internalCaseNumberstringRequired
receiverInternalCaseNumberstringOptional
problemSummarystringRequired
problemDescriptionstringRequired
prioritystring · enumRequiredPossible values:
adminNotestringOptional
escalationInstructionsstringOptional
testSubmissionbooleanRequired
Responses
chevron-right
200

Collaboration request created successfully

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
post
/v1/collaboration-requests

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
chevron-right
200

Collaboration request details

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
get
/v1/collaboration-requests/{token}

Update collaboration request submitter details

patch
Authorizations
Path parameters
tokenstringRequired

The token provided by TSANet for the collaboration request

Body
Responses
chevron-right
200

Collaboration request updated successfully

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
patch
/v1/collaboration-requests/{token}

Get collaboration requests (paginated)

get
Authorizations
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
chevron-right
200

Paginated list of collaboration requests

numberinteger · int32Optional
sizeinteger · int32Optional
totalElementsinteger · int64Optional
totalPagesinteger · int32Optional
firstbooleanOptional
lastbooleanOptional
get
/v2/collaboration-requests

List collaboration requests

get
Authorizations
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
chevron-right
200

List of collaboration requests

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
get
/v2/collaboration-requests/list

Last updated