About Data-Driven REST Web Services › View XSD Schemas for Data-Driven REST Web Services

View XSD Schemas for Data-Driven REST Web Services

Do the following steps before performing an HTTP request:

• Verify the XML schema definition (XSD) for the endpoint.
• Review the format of the return or upload XML that the service provides.

Each item of content that is placed in an XML document must adhere to the description of the endpoint.

To obtain the XSD for an endpoint, use the following paths with the data-driven web services URL:

http://hostname:port/rest/endpoint/XSD/operation.xsd

operation

Specifies the type of operation to execute.

The following operations are supported overall, but some are not supported for each endpoint:

get

Obtains the XSD for a single item get.

getlist

Obtains the XSD for a list of the endpoint items.

filterselect

Allows advanced filter criteria and return XML format to be specified using GET Tunneling.

create

Obtains the XSD that any input XML must match when trying to create.

update

Obtains the XSD that any input XML must match when trying to update.

Note: If an operation is not supported, the web service fails and returns a '403 Forbidden' message.

The automatically-generated XSD files for create, update, get, getlist, and filterselect contain tags that describe the attributes and the purpose of the metric families.