Advanced query a tag instance
post
/api/boss/data/objects/ora/cxServiceCore/common/v1/tags/{tags_id}/$query
Request
Path Parameters
-
tags_id(required): string
This path parameter maps to the following field defined in the Tags REST resource:
- value: The name of the tag.
Query Parameters
-
$effectiveDate: string(date)
Effective date value in the ISO 8601 date format 'YYYY-MM-DD'. This date is required by business logic to search for effective-dated business objects.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
accessors: object
accessors
Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
-
fields: array
fields
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
-
subTypes: object
subTypes
Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Nested Schema : accessors
Type:
object
Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
Nested Schema : fields
Type:
array
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
Show Source
Nested Schema : subTypes
Type:
object
Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Response
Default Response
A single item response
Nested Schema : Tag
Type:
object
Title:
Tag
Service request tags are used to manage keywords or terms assigned to a service request. Service request tags help in describing and classifying a service request.
Show Source
-
administratorCreatedFlag: boolean
Title:
Administrator Created
An indicator to denote that an administrator created the tag. -
createdBy: string
Title:
Created By
Read Only:true
The user who created the record. -
id: string
(big-integer)
Title:
Tag Value ID
Read Only:true
The unique identifier of the tag. -
timeCreated: string
(date-time)
Title:
Created On
Read Only:true
The date and time when the record was created. -
value: string
Title:
Tag
The name of the tag.
Links
- $self
-
Parameters:
- tags_id:
$request.path.tags_id
- tags_id: