SchemaResource
REST Resource for creating schema definitions, such as JSON/XML schemas..
The following resources are applicable:
/change-sets/{csId}/schemas/{name}
Mount Point: /change-sets/{csId}/schemas/{name}
The following operations are supported on this resource:
POST
Creates a schema used for validation.
Parameters
name | description | type | default |
---|---|---|---|
JSESSIONID | The User session ID | cookie | |
csId | The change set ID | path | |
name | The schema name | path |
Request Body
element: | schema |
media types: | application/xml text/xml application/json |
The schema to store
Response Body
element: | (custom) |
media types: | application/xml text/xml application/json |
Response object
PUT
Updates a schema used for validation.
Parameters
name | description | type | default |
---|---|---|---|
JSESSIONID | The User session ID | cookie | |
csId | The change set ID | path | |
name | The schema name | path |
Request Body
element: | schema |
media types: | application/xml text/xml application/json |
The schema to store
Response Body
element: | (custom) |
media types: | application/xml text/xml application/json |
Response object
GET
Gets a schema used for validation.
Parameters
name | description | type | default |
---|---|---|---|
JSESSIONID | The user session ID | cookie | |
csId | The change set ID | path | |
name | The name of the scheme | path | |
includeChain | if true, search all change sets in the chain. Otherwise, just this one. | query | false |
Response Body
element: | (custom) |
media types: | application/xml text/xml application/json |
ObjectNode schema
DELETE
Deletes a schema used for validation.
Parameters
name | description | type | default |
---|---|---|---|
JSESSIONID | The user session ID | cookie | |
csId | The change set ID | path | |
name | The name of the schema | path |