The following section describes the data types, other than response bodies, used by the Nintex Workflow for Office 365 REST API. For more information about response bodies, see Response bodies.
The following data types are provided by the REST API:
The Link object represents a relative link to another resource, such as an operation in the REST API.
| Name | Type | Nullable | Description |
|---|---|---|---|
| rel | string | false | The relation, or name, of the link. |
| href | string | true | The relative URL or URL template of the link. If isTemplated is set to true, this property contains a relative URL template; otherwise, this property contains a relative URL. In either case, the value is relative to the base URL of the REST API. For more information about the base URL, see Base URL. |
| isTemplated | boolean | false | If set to true, the value of the href property represents a relative URL template; otherwise, the value represents a relative URL. |
The Link objects provided by the REST API are compatible with the Hypertext Application Language (HAL) specification. For more information about the HAL specification, see HAL - Hypertext Application Language.
The following example illustrates a collection of Link objects, returned in the _links collection of a Message response body. All four Link objects represent relative URL templates, covering four operations included in the REST API.
"_links": [
{
"rel": "workflow.package.export",
"href": "/api/v1/workflows/packages/{id}",
"isTemplated": true
},
{
"rel": "workflow.package.importput",
"href": "/api/v1/workflows/packages/{id}",
"isTemplated": true
},
{
"rel": "workflow.publish",
"href": "/api/v1/workflows/{id}/published",
"isTemplated": true
},
{
"rel": "workflow.save",
"href": "/api/v1/workflows/{id}",
"isTemplated": true
}
]