Skip to navigation

Create ticket destination mapper

View as Markdown

Creates a ticket destination mapper and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
connector_idstringRequiredformat: "uuid">=1 character

Connector for the ticketing system whose tickets this mapper reads. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

versionobjectRequired
Document version. On update, send back the num from your last read.
mapper_benderobjectOptional
Data mapping, in Moveworks data mapper JSON, that converts a raw ticket into its ticket destination.
destination_field_mappingslist of objectsOptional
Ticket destination fields and the raw ticket fields that feed them. Needed only for ManageEngine.

Response

The created ticket destination mapper
idstringOptionalRead-only
Unique ID of this configuration, assigned by the server.
connector_idstringOptionalformat: "uuid">=1 character

Connector for the ticketing system whose tickets this mapper reads. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).

mapper_benderobjectOptional
Data mapping, in Moveworks data mapper JSON, that converts a raw ticket into its ticket destination.
destination_field_mappingslist of objectsOptional
Ticket destination fields and the raw ticket fields that feed them. Needed only for ManageEngine.
updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error