Form Request

Form templates for collaboration requests

Get a form by document ID

get

Authorizations

bearerAuth

Path parameters

documentIdinteger · int64Required

The identifier of the document form to retrieve

Responses

200

Form template for the document

application/jsonapplication/problem+json

documentIdinteger · int64Required

internalCaseNumberstringRequired

receiverInternalCaseNumberstringOptional

problemSummarystringRequired

problemDescriptionstringRequired

prioritystring · enumRequiredPossible values:

adminNotestringOptional

escalationInstructionsstringOptional

testSubmissionbooleanRequired

400

Bad request

application/jsonapplication/problem+json

401

Unauthorized

application/jsonapplication/problem+json

get

/v1/forms/document/{documentId}

HTTPcURLJavaScriptPython

GET /v1/forms/document/{documentId} HTTP/1.1
Host: connect2.tsanet.org
Accept: */*

{
  "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
}

Get a form by department ID

get

Authorizations

bearerAuth

Path parameters

departmentIdinteger · int64Required

The identifier of the department who you would like to collaborate with

Responses

200

Form template for the department

application/jsonapplication/problem+json

documentIdinteger · int64Required

internalCaseNumberstringRequired

receiverInternalCaseNumberstringOptional

problemSummarystringRequired

problemDescriptionstringRequired

prioritystring · enumRequiredPossible values:

adminNotestringOptional

escalationInstructionsstringOptional

testSubmissionbooleanRequired

400

Bad request

application/jsonapplication/problem+json

get

/v1/forms/department/{departmentId}

HTTPcURLJavaScriptPython

GET /v1/forms/department/{departmentId} HTTP/1.1
Host: connect2.tsanet.org
Accept: */*

{
  "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
}

Get a form by company ID

get

Authorizations

bearerAuth

Path parameters

companyIdinteger · int64Required

The identifier of the company who you would like to collaborate with

Responses

200

Form template for the company

application/jsonapplication/problem+json

documentIdinteger · int64Required

internalCaseNumberstringRequired

receiverInternalCaseNumberstringOptional

problemSummarystringRequired

problemDescriptionstringRequired

prioritystring · enumRequiredPossible values:

adminNotestringOptional

escalationInstructionsstringOptional

testSubmissionbooleanRequired

400

Bad request

application/jsonapplication/problem+json

401

Unauthorized

application/jsonapplication/problem+json

get

/v1/forms/company/{companyId}

HTTPcURLJavaScriptPython

GET /v1/forms/company/{companyId} HTTP/1.1
Host: connect2.tsanet.org
Accept: */*

{
  "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
}