Skip to main content

API documentation

note

Samples are genericized to mask proprietary information. Product images are mockups generated by Claude.

Excerpt from a REST API reference site

docs.clearpath.example/services/data-service/v2
ClearpathDocumentationAll REST API Docs Overview of Clearpath ServicesTutorials

Data Service v5.1.0

The Data Service exposes endpoints for creating, retrieving and managing resources. It integrates with the Identity Service and the Authorization Service.

Get started

  • Overview of Clearpath Services
  • Configure security
  • Use the API
  • Test with user tokens
  • Clearpath service health check standard
    • Shallow health check schema
    • Deep health check schema
  • Tutorials
Base URLhttps://api.clearpath.example/data/v2AuthenticationAuthorization: Bearer <access_token>

Resources

Resources are the core records managed by the Data Service. Each resource can have one or more attributes.

Retrieves all resources

Returns a paged collection of resources. Supports standard OData query options for filtering, sorting and shaping the results.

Query parameters
$expand
string

Expands related entities inline.

$filter
string

Filters the results, based on a Boolean condition.

$select
string

Selects which properties to include in the response.

$orderby
string

Sorts the results.

$top
integer <int32>

Returns only the first n results.

$skip
integer <int32>

Skips the first n results.

$count
boolean

Includes a count of the matching results in the response.

Responses

Response samples

Content typeapplication/json
{
"@odata.context": "https://api.clearpath.example/data/v2/$metadata#Resources",
"value": [
{
"Id": 1024,
"Name": "Example resource",
"Description": "A sample resource used to illustrate the response format.",
"Status": "Active",
"Category": "General",
"CreatedBy": "user.one",
"CreatedDate": "2026-09-14T16:22:08Z",
"LastModifiedBy": "user.two",
"LastModifiedDate": "2026-10-01T09:47:51Z",
"Attributes": [
{
"Id": 1,
"ResourceId": 1024,
"Key": "region",
"Value": "west"
}
]
}
]
}

Creates a resource

Creates a new resource and any attributes included in the request.

Request body schema: application/json
Namerequired
string

Display name of the resource. Must be unique.

Description
string

Optional description of the resource.

Statusrequired
string

Active, Inactive or Archived.

Category
string

Optional grouping used for filtering.

Attributes
Array of objects

Key-value pairs to attach to the resource.

Responses

Request samples

Payload
Content typeapplication/json
{
"Name": "Example resource",
"Description": "A sample resource used to illustrate the request format.",
"Status": "Active",
"Category": "General",
"Attributes": [
{
"Key": "region",
"Value": "west"
}
]
}

Response samples

Content typeapplication/json
{
"Id": 1024,
"Name": "Example resource",
"Description": "A sample resource used to illustrate the response format.",
"Status": "Active",
"Category": "General",
"CreatedBy": "user.one",
"CreatedDate": "2026-09-14T16:22:08Z",
"LastModifiedBy": "user.two",
"LastModifiedDate": "2026-10-01T09:47:51Z",
"Attributes": [
{
"Id": 1,
"ResourceId": 1024,
"Key": "region",
"Value": "west"
}
]
}

Retrieves a specific resource by ID

Returns a single resource, including its attributes when expanded.

Path parameters
idrequired
integer <int32>

Resource ID.

Query parameters
$expand
string

Expands related entities inline.

$select
string

Selects which properties to include in the response.

Responses

Response samples

Content typeapplication/json
{
"Id": 1024,
"Name": "Example resource",
"Description": "A sample resource used to illustrate the response format.",
"Status": "Active",
"Category": "General",
"CreatedBy": "user.one",
"CreatedDate": "2026-09-14T16:22:08Z",
"LastModifiedBy": "user.two",
"LastModifiedDate": "2026-10-01T09:47:51Z",
"Attributes": [
{
"Id": 1,
"ResourceId": 1024,
"Key": "region",
"Value": "west"
}
]
}

Updates a resource

Replaces an existing resource with the values in the request. Fields that are left out are reset to their defaults.

Path parameters
idrequired
integer <int32>

Resource ID.

Request body schema: application/json
Namerequired
string

Display name of the resource. Must be unique.

Description
string

Optional description of the resource.

Statusrequired
string

Active, Inactive or Archived.

Category
string

Optional grouping used for filtering.

Attributes
Array of objects

Key-value pairs to attach to the resource.

Responses

Request samples

Payload
Content typeapplication/json
{
"Name": "Example resource",
"Description": "A sample resource used to illustrate the request format.",
"Status": "Inactive",
"Category": "General",
"Attributes": [
{
"Key": "region",
"Value": "west"
}
]
}

Response samples

Content typeapplication/json
{
"Id": 1024,
"Name": "Example resource",
"Description": "A sample resource used to illustrate the response format.",
"Status": "Inactive",
"Category": "General",
"CreatedBy": "user.one",
"CreatedDate": "2026-09-14T16:22:08Z",
"LastModifiedBy": "user.two",
"LastModifiedDate": "2026-10-07T14:05:33Z",
"Attributes": [
{
"Id": 1,
"ResourceId": 1024,
"Key": "region",
"Value": "west"
}
]
}

Deletes a single resource

Permanently deletes a resource and its attributes. This action cannot be undone.

Path parameters
idrequired
integer <int32>

Resource ID.

Responses

Response samples

No response body