Create a JSON Schema
post
/apiManagement/jsonSchemas/{resource-owner}/{classifier}
Request
Path Parameters
-
classifier(required): string
Below is the valid value for 'classifier': * `common` - the value is a string. * ..
-
resource-owner(required): string
Below is the valid value for 'resource-owner': * `custom`- the value is a string. * ..
Supported Media Types
- application/json
Response
Supported Media Types
- application/json
201 Response
Created
400 Response
Bad Request
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
401 Response
Unauthorized
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
403 Response
Forbidden
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
404 Response
Not Found
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
409 Response
Conflict
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
500 Response
Internal Server Error
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
Examples
The following shows how to create a JSON schema by submitting a POST request on the REST resource using cURL.
cURL Command
curl -H 'Authorization: Bearer <Token>' -X POST
https://{FABRIC_HOST}/apiManagement/jsonSchemas/{resource-owner}/{classifier}
-D @create_jsonschema.json -H "Content-Type: application/json" |
json_pp
Request Body
The following shows the contents of the request body in JSON format.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "SIFAOracleCustomer.schema.json",
"title": "CustomerManagement",
"definitions": {
"SIFAOracleCustomer": {
"$id": "#SIFAOracleCustomer",
"type": "object",
"description": "This is a SIFAOracleCustomer after market extension Schema meant to extend the FAOracleCustomer",
"allOf": [
{
"$ref": "../../oracle/buying/FAOracleCustomer.schema.json#FAOracleCustomer"
}
],
"properties": {
"AnniversaryDate": {
"type":"string",
"format": "date",
"description": "Anniversary Date"
}
}
}
}
}
Response Body
The following shows the contents of the response body in JSON format.
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "SIFAOracleCustomer.schema.json",
"title": "CustomerManagement",
"definitions": {
"SIFAOracleCustomer": {
"$id": "#SIFAOracleCustomer",
"type": "object",
"description": "This is a SIFAOracleCustomer after market extension Schema meant to extend the FAOracleCustomer",
"allOf": [
{
"$ref": "../../oracle/buying/FAOracleCustomer.schema.json#FAOracleCustomer"
}
],
"properties": {
"AnniversaryDate": {
"type": "string",
"format": "date",
"description": "Anniversary Date"
}
}
}
},
"links": [
{
"rel": "self",
"href": "https://1/apiManagement/jsonSchemas/custom/common/SIFAOracleCustomer.schema.json"
}
]
}