Obtaining the REST Schema from OneData user interface
1. On the Menu toolbar, click Manage > Manage Data.
2. Select the object for which you want to generate the REST schema.
3. In the Data Manager screen, click View > Definition.
Note:
If the object mode is Default, click the Advanced Definition tab.
4. Click the + symbol next to External Services to expand the tab.
5. In Column Prefix, verify if the you have selected the right option:
No Prefix. Defined
XML/JSON Element Name or physical table name is not prefixed to the column name. Use this value when generating the REST schema for records created in
OneData versions 9.7 and earlier.
XML/JSON Element Name. The column prefix, which is the physical table name or the user-specified prefix name, specified in the
XML/JSON Element Name of the object definition. By default, the column prefix is included for all new records created in
OneData version 9.8 and later.
6. For Audit Comments attribute, select With audit comment.
7. Select the schema type as XML Schema or JSON Schema.
8. Select one of the following options to generate or download the schema:
Action | Description |
Generate Schema | Generates the REST schema. |
Download Schema | Downloads the REST schema. |
Generate Swagger | Generates swagger documentation to help you design, build and consume REST APIs. |
Download Swagger | Downloads swagger documentation to help you design, build and consume REST APIs. |
Generate Swagger URL | Generates the swagger URL. Note: Copy the Swagger URL and use it in your browser Swagger UI console. Provide the service layer username and password. |
Obtain the REST schema and construct XML/JSON according to this XSD/JSON. Using the HTTP client, POST the created XML/JSON through the RESTful web service link. For examples, to construct XML/JSON using REST schema, see
Examples of Payload by Object
Type.