Ticket

This documentation is currently outdated and in the process of being updated. This documentation is provided as a temporary reference to various API endpoints and output. This warning will be at the top of each outdated page. As the documentation is updated, this warning will be removed.

Returning Field List associated with this TemplateID for ConnectorID

Short description

API Call: ``

URL: ``

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can _____ are:

  • Group Manager
  • Manager

Python

Python Sample file_details Snippet

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token
ASSESSMENTNAME Name of assessment to create.
STARTDATE Assessment start date. Format YYYY-MM-DD.
NOTES Notes about the assessment. Optional

cURL

cURL Sample sample_file Snippet

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token

Response Parameters

Sample Response

Name Description Type
ID Assessment ID number. integer
NAME Name of assessment. string
STARTDATE Assessment start date. Format YYYY-MM-DD. string($date)
NOTES Assessment notes. string
CLIENTID Client ID number. integer

HTTP Status Codes

Code Description
201 Success

201 Sample Response

{
  "id": 12,
  "name": "Q2",
  "startDate": "2018-04-01",
  "notes": "",
  "clientId": 5
}
Code Description
400 User Error

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}
Code Description
401 Unauthorized
404 Not Found

Listing Selected Templates while Creating the Connector

Short description

API Call: ``

URL: ``

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can _____ are:

  • Group Manager
  • Manager

Python

Python Sample file_details Snippet

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token
ASSESSMENTNAME Name of assessment to create.
STARTDATE Assessment start date. Format YYYY-MM-DD.
NOTES Notes about the assessment. Optional

cURL

cURL Sample sample_file Snippet

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token

Response Parameters

Sample Response

Name Description Type
ID Assessment ID number. integer
NAME Name of assessment. string
STARTDATE Assessment start date. Format YYYY-MM-DD. string($date)
NOTES Assessment notes. string
CLIENTID Client ID number. integer

HTTP Status Codes

Code Description
201 Success

201 Sample Response

{
  "id": 12,
  "name": "Q2",
  "startDate": "2018-04-01",
  "notes": "",
  "clientId": 5
}
Code Description
400 User Error

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}
Code Description
401 Unauthorized
404 Not Found

Listing Catalog Item Fields Associated with the Connector

Short description

API Call: ``

URL: ``

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can _____ are:

  • Group Manager
  • Manager

Python

Python Sample file_details Snippet

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token
ASSESSMENTNAME Name of assessment to create.
STARTDATE Assessment start date. Format YYYY-MM-DD.
NOTES Notes about the assessment. Optional

cURL

cURL Sample sample_file Snippet

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token

Response Parameters

Sample Response

Name Description Type
ID Assessment ID number. integer
NAME Name of assessment. string
STARTDATE Assessment start date. Format YYYY-MM-DD. string($date)
NOTES Assessment notes. string
CLIENTID Client ID number. integer

HTTP Status Codes

Code Description
201 Success

201 Sample Response

{
  "id": 12,
  "name": "Q2",
  "startDate": "2018-04-01",
  "notes": "",
  "clientId": 5
}
Code Description
400 User Error

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}
Code Description
401 Unauthorized
404 Not Found

Getting Issue Type Field List Associated with the Connector

Short description

API Call: ``

URL: ``

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can _____ are:

  • Group Manager
  • Manager

Python

Python Sample file_details Snippet

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token
ASSESSMENTNAME Name of assessment to create.
STARTDATE Assessment start date. Format YYYY-MM-DD.
NOTES Notes about the assessment. Optional

cURL

cURL Sample sample_file Snippet

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token

Response Parameters

Sample Response

Name Description Type
ID Assessment ID number. integer
NAME Name of assessment. string
STARTDATE Assessment start date. Format YYYY-MM-DD. string($date)
NOTES Assessment notes. string
CLIENTID Client ID number. integer

HTTP Status Codes

Code Description
201 Success

201 Sample Response

{
  "id": 12,
  "name": "Q2",
  "startDate": "2018-04-01",
  "notes": "",
  "clientId": 5
}
Code Description
400 User Error

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}
Code Description
401 Unauthorized
404 Not Found

Creating a New Ticket

Short description

API Call: ``

URL: ``

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can _____ are:

  • Group Manager
  • Manager

Python

Python Sample file_details Snippet

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token
ASSESSMENTNAME Name of assessment to create.
STARTDATE Assessment start date. Format YYYY-MM-DD.
NOTES Notes about the assessment. Optional

cURL

cURL Sample sample_file Snippet

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token

Response Parameters

Sample Response

Name Description Type
ID Assessment ID number. integer
NAME Name of assessment. string
STARTDATE Assessment start date. Format YYYY-MM-DD. string($date)
NOTES Assessment notes. string
CLIENTID Client ID number. integer

HTTP Status Codes

Code Description
201 Success

201 Sample Response

{
  "id": 12,
  "name": "Q2",
  "startDate": "2018-04-01",
  "notes": "",
  "clientId": 5
}
Code Description
400 User Error

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}
Code Description
401 Unauthorized
404 Not Found

Getting Information about a Specific Ticket

Short description

API Call: ``

URL: ``

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can _____ are:

  • Group Manager
  • Manager

Python

Python Sample file_details Snippet

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token
ASSESSMENTNAME Name of assessment to create.
STARTDATE Assessment start date. Format YYYY-MM-DD.
NOTES Notes about the assessment. Optional

cURL

cURL Sample sample_file Snippet

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token

Response Parameters

Sample Response

Name Description Type
ID Assessment ID number. integer
NAME Name of assessment. string
STARTDATE Assessment start date. Format YYYY-MM-DD. string($date)
NOTES Assessment notes. string
CLIENTID Client ID number. integer

HTTP Status Codes

Code Description
201 Success

201 Sample Response

{
  "id": 12,
  "name": "Q2",
  "startDate": "2018-04-01",
  "notes": "",
  "clientId": 5
}
Code Description
400 User Error

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}
Code Description
401 Unauthorized
404 Not Found

Delete a Ticket

Short description

API Call: ``

URL: ``

URL Parameters

Name Description Additional Information
PLATFORM Platform number. If you are on platform 1, you do not need to put a number.
CLIENTID Client ID number. Finding Your Client ID

User Roles

The user roles that can _____ are:

  • Group Manager
  • Manager

Python

Python Sample file_details Snippet

Make sure to replace the angle bracket parameters here with your own values.

Python Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token
ASSESSMENTNAME Name of assessment to create.
STARTDATE Assessment start date. Format YYYY-MM-DD.
NOTES Notes about the assessment. Optional

cURL

cURL Sample sample_file Snippet

Make sure to replace the angle bracket parameters here with your own values.

cURL Parameters

Name Description Additional Information
PLATFORM Platform number.
CLIENTID Client ID number. Finding Your Client ID
APIKEY Your designated API key. Generating an API Token

Response Parameters

Sample Response

Name Description Type
ID Assessment ID number. integer
NAME Name of assessment. string
STARTDATE Assessment start date. Format YYYY-MM-DD. string($date)
NOTES Assessment notes. string
CLIENTID Client ID number. integer

HTTP Status Codes

Code Description
201 Success

201 Sample Response

{
  "id": 12,
  "name": "Q2",
  "startDate": "2018-04-01",
  "notes": "",
  "clientId": 5
}
Code Description
400 User Error

400 Sample Response

{
  "status": 0,
  "path": "string",
  "errors": [
    {
      "field": "string",
      "code": "string"
    }
  ]
}
Code Description
401 Unauthorized
404 Not Found