Comment on page

Error models

This article describes API error formats

Based on response HTTP status code, one of following error models are returned in response body.
ProblemDetails
A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807.
Name
Type
Description
type
string?
A URI reference [RFC3986] that identifies the problem type.
title
string?
A short, human-readable summary of the problem type.
status
int?
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
detail
string?
A human-readable explanation specific to this occurrence of the problem.
instance
string?
A request URI path.
traceId
string?
Unique identifier to represent this request in trace logs.
errorCode
int?
​API error code, if applicable.
resource
​ResourceInfo?​
Information about resource present in request. Available when errorCode is 6 (Version mismatch)​
PortosValidationProblemDetails
This class inherits all properties from ProblemDetails, and adds properties listed below:
Name
Type
Description
errors
​PortosValidationProblemDetailsError[]​
Collection of errors. Each element represents one broken validation rule. 
PortosValidationProblemDetailsError
Name
Type
Description
memberName
string
Property name.
message
string
Message that describes error.
code
string?
One of validation constraints, if applicable.
ResourceInfo
Name
Type
Description
name
string
​Resource name​
id
string
Unique resource identifier
version
int?
Resource version
​

Name	Type	Description
`type`	`string?`	A URI reference [RFC3986] that identifies the problem type.
`title`	`string?`	A short, human-readable summary of the problem type.
`status`	`int?`	The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
`detail`	`string?`	A human-readable explanation specific to this occurrence of the problem.
`instance`	`string?`	A request URI path.
`traceId`	`string?`	Unique identifier to represent this request in trace logs.
`errorCode`	`int?`	API error code, if applicable.
`resource`	`ResourceInfo?`	Information about resource present in request. Available when errorCode is 6 (Version mismatch)

Name	Type	Description
`errors`	`PortosValidationProblemDetailsError[]`	Collection of errors. Each element represents one broken validation rule.

Name	Type	Description
`memberName`	`string`	Property name.
`message`	`string`	Message that describes error.
`code`	`string?`	One of validation constraints, if applicable.

Name	Type	Description
`name`	`string`	Resource name
`id`	`string`	Unique resource identifier
`version`	`int?`	Resource version

HTTP Status codes

Error codes

Last modified 1yr ago