Sign in
latestOpenAPI 3.0.12026-08-2275117361.7 KB

3cf1fe47664a

Request

Validate customer request

Validates a customer request payload without creating (persisting) a request.

This endpoint runs exactly the same structural and semantic validations as Create customer request \u2014 including ProForma form validation \u2014 but performs no mutation: no issue is created and no side effects (attachments, comments, analytics) run.

The response is intentionally verbose and structured so that it can be consumed by automated agents (for example an LLM repairing an invalid payload): every failure carries a machine-readable location (field id / form entity) and a human-readable reason. A valid payload returns HTTP 200 with {@code valid: true}; an invalid payload returns HTTP 400 with {@code valid: false} together with the field, form and general validation errors.

Permissions required: Permission to create requests in the specified service desk.

post/rest/servicedeskapi/request/validate

Request body

channelstring

(Experimental) Shows extra information for the request channel.

isAdfRequestboolean

(Experimental) Whether to accept rich text fields in Atlassian Document Format (ADF).

raiseOnBehalfOfstring

The accountId of the customer that the request is being raised on behalf of.

requestFieldValuesobject

JSON map of Jira field IDs and their values representing the content of the request.

requestParticipantsstring[]

List of customers to participate in the request, as a list of accountId values.

requestTypeIdstring

ID of the request type for the request.

serviceDeskIdstring

ID of the service desk in which to create the request.

Response

Returned with the validation result. {@code valid} is true when the payload is valid.

errorMessagestring

A single, human-readable summary describing why validation failed. Null when valid.

errorMessagesstring[]

General validation errors that are not attributable to a single field. Empty when valid.

reasonKeystring

A machine-readable reason key categorising the overall failure. Null when valid.

validboolean

True when the payload is both structurally and semantically valid and safe to create.