AuthnpoliciesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/AuthnPolicy"
}
}
AutotaskCompany
{
"type": "object",
"title": "AutotaskCompany",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "The autotask company identifier."
},
"name": {
"type": "string",
"description": "The autotask company name."
}
},
"description": "Autotask company details"
}
AutotaskCompanyResp
{
"type": "object",
"title": "AutotaskCompanyResp",
"required": [
"totalCount",
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskCompany"
}
},
"totalCount": {
"type": "integer"
}
},
"description": "Response for retrieving Autotask companies"
}
AutotaskCompanyTypeResp
{
"type": "object",
"required": [
"totalCount",
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillingIntegrationCompanyType"
}
},
"totalCount": {
"type": "integer"
}
},
"description": "Response for retrieving Autotask company types"
}
AutotaskContract
{
"type": "object",
"title": "AutotaskContract",
"required": [
"id",
"name",
"companyId"
],
"properties": {
"id": {
"type": "string",
"description": "The contract identifier."
},
"name": {
"type": "string",
"description": "The contract name."
},
"companyId": {
"type": "string",
"description": "The Autotask company identifier linked to contract."
}
},
"description": "Autotask contract details"
}
AutotaskContractField
{
"type": "object",
"title": "AutotaskContractField",
"required": [
"name",
"values"
],
"properties": {
"name": {
"type": "string",
"description": "The contract field name."
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
},
"description": "Autotask contract field details"
}
AutotaskCreateConfiguration422Response
{
"type": "object",
"properties": {}
}
AutotaskCreateConfigurationResponse
{
"type": "object",
"required": [
"integrationId"
],
"properties": {
"integrationId": {
"type": "string",
"description": "The identifier of the created integration"
}
}
}
AutotaskIntegration
{
"type": "object",
"title": "Get Autotask integration GET object",
"required": [
"id",
"username"
],
"properties": {
"id": {
"type": "string",
"description": "The identifier for this Autotask integration."
},
"username": {
"type": "string",
"description": "The username for connecting to Autotask."
},
"isMspAuthConfigured": {
"type": "boolean",
"description": "Has the msp-api been configured with auth data yet"
}
},
"description": "Autotask integration configuration details"
}
AutotaskIntegrationPatchReq
{
"type": "object",
"title": "Create Autotask Integration PATCH object",
"properties": {
"secret": {
"type": "string",
"description": "The secret for connecting to Autotask."
},
"username": {
"type": "string",
"description": "The username for connecting to Autotask."
}
},
"description": "Request for updating a Autotask integration"
}
AutotaskIntegrationReq
{
"type": "object",
"title": "Create Autotask Integration POST object",
"required": [
"username",
"secret"
],
"properties": {
"secret": {
"type": "string",
"description": "The secret for connecting to Autotask."
},
"username": {
"type": "string",
"description": "The username for connecting to Autotask."
}
},
"description": "Request for creating a Autotask integration"
}
AutotaskMappingRequest
{
"type": "object",
"title": "AutotaskMappingRequest",
"minItems": 1,
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"required": [
"organization",
"company"
],
"properties": {
"delete": {
"type": "boolean"
},
"company": {
"$ref": "#/components/schemas/AutotaskMappingRequestCompany"
},
"service": {
"$ref": "#/components/schemas/AutotaskMappingRequestService"
},
"contract": {
"$ref": "#/components/schemas/AutotaskMappingRequestContract"
},
"organization": {
"$ref": "#/components/schemas/AutotaskMappingRequestOrganization"
}
}
}
}
},
"description": "Request object for creating Autotask mappings"
}
AutotaskMappingRequestCompany
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
AutotaskMappingRequestContract
{
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
}
}
}
AutotaskMappingRequestOrganization
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
}
}
}
AutotaskMappingRequestService
{
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"name": {
"type": "string",
"nullable": true
},
"nonBillableUsers": {
"type": "integer",
"nullable": true
}
}
}
AutotaskMappingResponse
{
"type": "object",
"title": "AutotaskMappingResponse",
"properties": {
"company": {
"$ref": "#/components/schemas/AutotaskMappingResponseCompany"
},
"service": {
"$ref": "#/components/schemas/AutotaskMappingResponseService"
},
"contract": {
"$ref": "#/components/schemas/AutotaskMappingResponseContract"
},
"organization": {
"$ref": "#/components/schemas/AutotaskMappingResponseOrganization"
},
"lastSyncStatus": {
"type": "string"
},
"lastSyncDateTime": {
"type": "string"
}
},
"description": "Autotask mapping GET response"
}
AutotaskMappingResponseCompany
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
AutotaskMappingResponseContract
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
AutotaskMappingResponseOrganization
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
AutotaskMappingResponseService
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"nonBillableUsers": {
"type": "integer"
}
}
}
AutotaskRetrieveContractsFieldsResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskContractField"
}
},
"totalCount": {
"type": "integer"
}
}
}
AutotaskRetrieveContractsResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskContract"
}
},
"totalCount": {
"type": "integer"
}
}
}
AutotaskRetrieveMappingsResponse
{
"type": "object",
"properties": {
"records": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskMappingResponse"
}
},
"totalCount": {
"type": "number"
}
}
}
AutotaskRetrieveServicesResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskService"
}
},
"totalCount": {
"type": "integer"
}
}
}
AutotaskService
{
"type": "object",
"title": "AutotaskService",
"required": [
"id",
"name",
"contractId"
],
"properties": {
"id": {
"type": "string",
"description": "The contract service identifier."
},
"name": {
"type": "string",
"description": "The autotask service name linked to this contract service."
},
"contractId": {
"type": "string",
"description": "The autotask contract identifier linked to this contract service."
}
},
"description": "Autotask contract service details"
}
AutotaskSettings
{
"type": "object",
"title": "Get Autotask integration settings GET object",
"properties": {
"companyTypeIds": {
"type": "array",
"items": {
"type": "integer"
},
"description": "The array of Autotask companyType IDs applicable to the Provider."
},
"automaticTicketing": {
"type": "boolean",
"description": "Determine whether Autotask uses automatic ticketing"
}
},
"description": "Autotask integration settings"
}
AutotaskSettingsPatchReq
{
"type": "object",
"title": "Update Autotask Integration's Settings PATCH object",
"properties": {
"companyTypeIds": {
"type": "array",
"items": {
"type": "integer"
},
"maxItems": 150,
"description": "The array of Autotask companyType IDs applicable to the Provider."
},
"automaticTicketing": {
"type": "boolean",
"description": "Determine whether Autotask uses automatic ticketing"
}
},
"x-examples": {
"example-1": {
"companyTypeIds": [
0,
1
],
"automaticTicketing": true
}
},
"description": "Request for updating a Autotask integration's settings"
}
AutotaskTicketingAlertConfiguration
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"queue": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"source": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"dueDays": {
"type": "integer"
},
"category": {
"type": "string"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"resource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
}
}
},
"description": {
"type": "string"
},
"destination": {
"enum": [
"queue",
"resource"
],
"type": "string"
},
"displayName": {
"type": "string"
},
"shouldCreateTickets": {
"type": "boolean"
}
},
"description": "An AutotaskTicketingAlertConfiguration object requires a queueId if the destination is queue. If the destination is resource, resource.id and resource.role.id are required."
}
AutotaskTicketingAlertConfigurationList
{
"type": "object",
"required": [
"records"
],
"properties": {
"records": {
"type": "array",
"items": {
"allOf": [
{
"type": "object",
"properties": {
"alertId": {
"type": "string"
}
}
},
{
"$ref": "#/components/schemas/AutotaskTicketingAlertConfiguration"
}
]
}
}
}
}
AutotaskTicketingAlertConfigurationOption
{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"values": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
}
}
}
AutotaskTicketingAlertConfigurationOptions
{
"type": "object",
"properties": {
"options": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskTicketingAlertConfigurationOption"
}
},
"resources": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AutotaskTicketingAlertConfigurationResource"
}
}
}
}
AutotaskTicketingAlertConfigurationRequest
{
"type": "object",
"required": [
"shouldCreateTickets",
"priority",
"status",
"dueDays",
"destination"
],
"properties": {
"queue": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"source": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"status": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"dueDays": {
"type": "integer"
},
"priority": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
},
"resource": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"role": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
}
}
}
}
},
"destination": {
"enum": [
"queue",
"resource"
],
"type": "string"
},
"shouldCreateTickets": {
"type": "boolean"
}
},
"description": "An AutotaskTicketingAlertConfigurationRequest object requires a queueId if the destination is queue. If the destination is resource, resource.id and resource.role.id are required."
}
AutotaskTicketingAlertConfigurationResource
{
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"roles": {
"type": "array",
"items": {
"type": "object",
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "integer"
}
}
}
}
}
}
AutotaskUpdateConfigurationResponse
{
"type": "object",
"properties": {}
}
BillingGetContractResponse
{
"type": "string",
"format": "binary"
}
BillingIntegrationCompanyType
{
"type": "object",
"required": [
"id",
"name"
],
"properties": {
"id": {
"type": "number",
"description": "The company type identifier."
},
"name": {
"type": "string",
"description": "The company type name."
}
},
"description": "Billing Integration company type"
}
BulkUserExpiresRequest
{
"type": "array",
"items": {
"$ref": "#/components/schemas/bulk-user-expire"
}
}
BulkUserStatesCreate400Response
{
"type": "object",
"properties": {}
}
BulkUserStatesCreate401Response
{
"type": "object",
"properties": {}
}
BulkUserStatesCreate500Response
{
"type": "object",
"properties": {}
}
BulkUserStatesCreateResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/scheduled-userstate-result"
}
}
BulkUserStatesGetNextScheduledResponse
{
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/scheduled-userstate-result"
}
},
"events_count": {
"type": "integer",
"description": "The total number of ACTIVATED and SUSPENDED events to a max depth of 1 for\nall of the users in the query. A value larger than the limit specified on\nthe query indicates that additional calls are needed, using a skip greater\nthan 0, to retrieve the full set of results."
}
}
}
BulkUserStatesListResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/scheduled-userstate-result"
}
}
BulkUserUnlocksRequest
{
"type": "array",
"items": {
"$ref": "#/components/schemas/bulk-user-unlock"
}
}
BulkUsersCreateRequest
{
"type": "array",
"items": {
"$ref": "#/components/schemas/bulk-user-create"
}
}
BulkUsersCreateResultsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/job-workresult"
}
}
BulkUsersUpdateRequest
{
"type": "array",
"items": {
"$ref": "#/components/schemas/bulk-user-update"
}
}
Case
{
"type": "object",
"title": "Case",
"properties": {
"os": {
"type": "string"
},
"date": {
"type": "string"
},
"label": {
"type": "string"
},
"status": {
"type": "string"
},
"subject": {
"type": "string"
},
"reporter": {
"type": "string"
},
"caseNumber": {
"type": "string"
},
"description": {
"type": "string"
},
"organization": {
"type": "string"
},
"reporterEmail": {
"type": "string"
},
"caseSubmissionProductType": {
"type": "string"
}
},
"description": "Details of the case (support/feature request)"
}
CasesMetadataResponse
{
"type": "object",
"title": "CasesMetadataResponse",
"properties": {
"results": {
"type": "object",
"properties": {
"os": {
"type": "array",
"items": {
"type": "string"
}
},
"products": {
"type": "array",
"items": {
"type": "string"
}
},
"statuses": {
"type": "array",
"items": {
"type": "string"
}
},
"caseTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"severities": {
"type": "array",
"items": {
"type": "string"
}
},
"productServiceGroups": {
"type": "array",
"items": {
"type": "string"
}
},
"preferredResponseTimes": {
"type": "array",
"items": {
"type": "string"
}
},
"caseSubmissionProductTypes": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"description": "Response for retrieving the cases's metdata"
}