Schema of Web Services

The Schema tab contains information about the fields of the web service. Depending on the type of web service, the information it provides is different.

Schema of SOAP Web Services

A SOAP web service consists of several operations. For each operation, the Schema tab shows a section with its name. Expand an operation and you will access two schemas: the input and output schemas of the operation.

The Schema tab of a SOAP web service shows information about the parameters and return values of its operations

The Schema tab of a SOAP web service shows information about the parameters and return values of its operations

The input schema of an operation represents the list of parameters it can receive. For each input parameter, it shows:

  • Its name.

  • Its type.

  • A description in plain text specific to the Data Catalog.

  • The operator used to query the underlying view.

As a result, a SOAP operation returns an array of elements. Each element in the array corresponds to a tuple in the undelying view and, therefore, it is composed of several fields. For each field of a return value, the output schema provides:

  • Its name.

  • Its type.

  • A description in plain text specific to the Data Catalog.

Note

The Schema tab for a SOAP web service only shows information on the operations that retrieve information on views. Operations that insert, update or remove data are not considered.

Schema of REST Web Services

A REST web service consists of a set of resources, each one representing a view in Virtual DataPort. For each resource, the Schema tab shows a section with its name. Expand a resource and you will access information about its fields.

The Schema tab of a REST web service shows information about the fields of its resources

The Schema tab of a REST web service shows information about the fields of its resources

For each field, it provides:

  • Its name.

  • Its type.

  • A description in plain text specific to the Data Catalog.

  • Its status. By default, all fields in a view can be used as input and output fields of the resource. However, there are scenarios where a field needs to be restricted and its status changes to:

    • Mandatory. Every request must provide a value for the field. When a field is mandatory, a mandatory icon will appear next to its name.

    • No searchable. The field cannot be used as input of a request. You will find the label No searchable under the Input/Output column.

    • Do not output. The field cannot appear in the output of a request. You will find the label Do not output under the Input/Output column.


Both SOAP and REST web services show a description for each field in the schema. If you have the proper permissions, you will see a edit icon next to the description. Click it and define a new description, which will be available for all users of the Data Catalog.

Note

This tab shows how the schema was in the last synchronization. Therefore, if the schema in Virtual DataPort has changed since then, these changes will not be reflected. However, if this web service has never been synchronized, this tab will show the current schema in Virtual DataPort.