REST APIs for Oracle Health Clinical Data Exchange

Create a QueryEndpoint

post

/20180828/queryEndpoints

This path creates a QueryEndpoint.

Request

Header Parameters

opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
opc-retry-token: string

Minimum Length: 1

Maximum Length: 64

A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.

The details for the new QueryEndpoint.

Root Schema : CreateQueryEndpointDetails

Type: object

The data that is used to create a QueryEndpoint.

Show Source

allowedSans: array allowedSans

Minimum Number of Items: 0

Maximum Number of Items: 5

The allowed list of CN, SAN, or client certificates that are used to verify the certificate.
caBundleId: string

The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CA bundle that is used to validate the client certificate.
clientAppDetails(required): object ClientAppDetails

Information about the client application.
compartmentId(required): string

Minimum Length: 1

Maximum Length: 255

The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which you want to create the QueryEndpoint.
definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
description: string

Minimum Length: 1

Maximum Length: 2048

A detailed description of the query endpoint. This value can be changed.
displayName: string

Minimum Length: 1

Maximum Length: 255

A user-friendly name. This name does not have to be unique, and it can be changed. Avoid entering confidential information.
framework(required): string

The framework that is used for queries, and for organizing and formatting the returned data.
freeformTags: object freeformTags

Additional Properties Allowed: additionalProperties

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
identityDomainUrl(required): string

A fully-formed URL that is an Oracle Identity Domain endpoint used for authentication.
payerId(required): string

The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Payer using this endpoint.

{
    "description":"The data that is used to create a QueryEndpoint.",
    "type":"object",
    "required":[
        "compartmentId",
        "payerId",
        "framework",
        "identityDomainUrl",
        "clientAppDetails"
    ],
    "properties":{
        "payerId":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Payer using this endpoint.",
            "type":"string"
        },
        "framework":{
            "description":"The framework that is used for queries, and for organizing and formatting the returned data.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/QueryEndpoint/framework"
        },
        "identityDomainUrl":{
            "description":"A fully-formed URL that is an Oracle Identity Domain endpoint used for authentication.",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. This name does not have to be unique, and it can be changed. Avoid entering confidential information.",
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        },
        "description":{
            "description":"A detailed description of the query endpoint. This value can be changed.",
            "type":"string",
            "minLength":"1",
            "maxLength":"2048"
        },
        "compartmentId":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which you want to create the QueryEndpoint.\n",
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        },
        "caBundleId":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CA bundle that is used to validate the client certificate.",
            "type":"string"
        },
        "allowedSans":{
            "description":"The allowed list of CN, SAN, or client certificates that are used to verify the certificate.",
            "type":"array",
            "items":{
                "type":"string"
            },
            "minItems":"0",
            "maxItems":"5"
        },
        "clientAppDetails":{
            "$ref":"#/definitions/ClientAppDetails"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported.\n"
                }
            }
        }
    }
}

Nested Schema : allowedSans

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 5

The allowed list of CN, SAN, or client certificates that are used to verify the certificate.

Show Source

Array of: string

{
    "description":"The allowed list of CN, SAN, or client certificates that are used to verify the certificate.",
    "type":"array",
    "items":{
        "type":"string"
    },
    "minItems":"0",
    "maxItems":"5"
}

Nested Schema : ClientAppDetails

Type: object

Information about the client application.

Show Source

clientId(required): string

The ID of the client application under the payer identity domain.

{
    "description":"Information about the client application.",
    "type":"object",
    "required":[
        "clientId"
    ],
    "properties":{
        "clientId":{
            "type":"string",
            "description":"The ID of the client application under the payer identity domain."
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported.\n"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported.\n"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Response

Supported Media Types

application/json

201 Response

The request was accepted. The QueryEndpoint will be created.

Headers

content-location: string(uri-reference)

See the location description above.
etag: string

For optimistic concurrency control. See `if-match`.
location: string(uri-reference)

The URL for the created constraints object. The object's OCID is generated after this request is sent.
opc-request-id: string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
opc-work-request-id: string

The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request.

Root Schema : QueryEndpoint

Type: object

A QueryEndpoint specifies where a payer may query our systems using a given format, and the information that is necessary to handle authentication for those queries.

Show Source

allowedSans: array allowedSans

Minimum Number of Items: 0

Maximum Number of Items: 5

The allowed list of CN, SAN, or client certificates that are used to verify the certificate.
caBundleId: string

The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CA bundle that is used to validate the client certificate.
clientAppDetails(required): object ClientAppDetails

Information about the client application.
compartmentId(required): string

The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
definedTags: object definedTags

Additional Properties Allowed: additionalProperties

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
description: string

A detailed description of the query endpoint. This value can be changed.
displayName: string

A user-friendly name. This name does not have to be unique, and it can be changed.
framework(required): string

Allowed Values: [ "FHIR", "IHE" ]

The framework that is used for the queries, and for organizing and formatting the returned data.
freeformTags: object freeformTags

Additional Properties Allowed: additionalProperties

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
id(required): string

The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the QueryEndpoint.
identityDomainUrl(required): string

A fully-formed URL that is an Oracle Identity Domain endpoint used for authentication.
lifecycleDetails: string

A message that describes the current state of the QueryEndpoint in more detail. For example, this message can be used to provide actionable information for a resource in a Failed state.
lifecycleState(required): string

Allowed Values: [ "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ]

The current state of the QueryEndpoint.
payerId(required): string

The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Payer who uses this endpoint.
systemTags: object systemTags

Additional Properties Allowed: additionalProperties

System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
timeCreated(required): string(date-time)

The date and time that the QueryEndpoint was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). For example, `2016-08-25T21:10:29.600Z`
timeUpdated: string(date-time)

The date and time that the QueryEndpoint was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). For example, `2016-08-25T21:10:29.600Z`
url(required): string

A fully-formed URL to which queries may be issued. This URL is generated by Clinical Data Exchange, not by the customer.

{
    "description":"A QueryEndpoint specifies where a payer may query our systems using a given format, and the information that is necessary to\nhandle authentication for those queries.\n",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"queryEndpoint",
        "ocidEntityType":"cdexhubqueryendpoint",
        "adLocality":"regional",
        "activeLifecycleStates":[
            "ACTIVE"
        ],
        "deletedLifecycleStates":[
            "DELETED"
        ],
        "getOperationId":"GetQueryEndpoint",
        "listResourcesOperationId":"ListQueryEndpoints",
        "searchMetadata":{
            "resourceSchemaVersion":"1",
            "resourceType":"QueryEndpoint",
            "scope":"${rqs_scope}"
        },
        "workRequestDetails":{
            "workRequestEntityType":"cdexhubworkrequest",
            "workRequestGetOperationId":"GetWorkRequest",
            "successfulLifecycleStates":[
                "SUCCEEDED"
            ],
            "failedLifecycleStates":[
                "FAILED",
                "CANCELED"
            ]
        }
    },
    "required":[
        "id",
        "payerId",
        "url",
        "framework",
        "identityDomainUrl",
        "compartmentId",
        "lifecycleState",
        "timeCreated",
        "clientAppDetails"
    ],
    "properties":{
        "id":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the QueryEndpoint.",
            "type":"string"
        },
        "payerId":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the Payer who uses this endpoint.",
            "type":"string"
        },
        "url":{
            "description":"A fully-formed URL to which queries may be issued. This URL is generated by Clinical Data Exchange, not by the customer.",
            "type":"string"
        },
        "framework":{
            "description":"The framework that is used for the queries, and for organizing and formatting the returned data.",
            "type":"string",
            "enum":[
                "FHIR",
                "IHE"
            ]
        },
        "identityDomainUrl":{
            "description":"A fully-formed URL that is an Oracle Identity Domain endpoint used for authentication.",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. This name does not have to be unique, and it can be changed.",
            "type":"string"
        },
        "description":{
            "description":"A detailed description of the query endpoint. This value can be changed.",
            "type":"string"
        },
        "compartmentId":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
            "type":"string"
        },
        "caBundleId":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CA bundle that is used to validate the client certificate.",
            "type":"string"
        },
        "allowedSans":{
            "description":"The allowed list of CN, SAN, or client certificates that are used to verify the certificate.",
            "type":"array",
            "items":{
                "type":"string"
            },
            "minItems":"0",
            "maxItems":"5"
        },
        "timeCreated":{
            "description":"The date and time that the QueryEndpoint was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\n\nFor example, `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The date and time that the QueryEndpoint was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\n\nFor example, `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "lifecycleState":{
            "description":"The current state of the QueryEndpoint.",
            "type":"string",
            "enum":[
                "CREATING",
                "UPDATING",
                "ACTIVE",
                "DELETING",
                "DELETED",
                "FAILED"
            ]
        },
        "lifecycleDetails":{
            "description":"A message that describes the current state of the QueryEndpoint in more detail. For example, this message\ncan be used to provide actionable information for a resource in a Failed state.\n",
            "type":"string"
        },
        "clientAppDetails":{
            "$ref":"#/definitions/ClientAppDetails"
        },
        "freeformTags":{
            "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported.\n"
                }
            }
        },
        "systemTags":{
            "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only the String type is supported.\n"
                }
            }
        }
    }
}

Nested Schema : allowedSans

Type: array

Minimum Number of Items: 0

Maximum Number of Items: 5

The allowed list of CN, SAN, or client certificates that are used to verify the certificate.

Show Source

Array of: string

{
    "description":"The allowed list of CN, SAN, or client certificates that are used to verify the certificate.",
    "type":"array",
    "items":{
        "type":"string"
    },
    "minItems":"0",
    "maxItems":"5"
}

Nested Schema : ClientAppDetails

Type: object

Information about the client application.

Show Source

clientId(required): string

The ID of the client application under the payer identity domain.

{
    "description":"Information about the client application.",
    "type":"object",
    "required":[
        "clientId"
    ],
    "properties":{
        "clientId":{
            "type":"string",
            "description":"The ID of the client application under the payer identity domain."
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported.\n"
        }
    }
}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

Additional Properties Allowed: additionalProperties

Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

{
    "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only the String type is supported.\n"
        }
    }
}

System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported.\n"
    }
}

Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

object additionalProperties

The value of the tag. Only the String type is supported.

{
    "type":"object",
    "description":"Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only the String type is supported.\n"
    }
}

Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only the String type is supported.

401 Response

Unauthorized

Headers

opc-request-id: string

Unique identifier for the request

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found

Headers

opc-request-id: string

Unique identifier for the request

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

409 Response

Conflict

Headers

opc-request-id: string

Unique identifier for the request

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

opc-request-id: string

Unique identifier for the request

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

opc-request-id: string

Unique identifier for the request

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

An error has occurred.

Headers

opc-request-id: string

Unique identifier for the request

Root Schema : Error

Type: object

Error information.

Show Source

code(required): string

A short error code that defines the error, meant for programmatic parsing.
message(required): string

A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}