Get all tag instances
get
/api/boss/data/objects/ora/cxServiceCore/common/v1/tags
Request
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.
-
$fields: string
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
-
$filter: string
The resource collection will be queried using the specified filter condition.
-
$limit: integer
Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items.Default Value:
25
-
$offset: integer
Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.Default Value:
0
-
$sortBy: string
Orders a resource collection based on the specified fields. The parameter value is a comma-separated string of field names, each optionally followed by a colon and "asc" (default) or "desc".
There's no request body for this operation.
Back to TopResponse
Default Response
An array of items 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.
Examples
The following example shows how to get all tags by submitting a GET request on the REST resource.
cURL Command
curl -X GET --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServieCore/common/v1/tags/ \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items": [ { "id": "300100572628629", "value": "BOSSTags_15476", "administratorCreatedFlag": false, "createdBy": "albert.truong@oracle.com", "timeCreated": "2023-03-13T11:48:23.773426Z", "$id": "300100572628629", "$context": { "etag": "1", "links": { "$self": { "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1:17/tags/300100572628629" } } } }, { "id": "300100572628631", "value": "BOSSTags_28187", "administratorCreatedFlag": false, "createdBy": "albert.truong@oracle.com", "timeCreated": "2023-03-13T11:49:00.488771Z", "$id": "300100572628631", "$context": { "etag": "1", "links": { "$self": { "href": "https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxServiceCore/common/v1:17/tags/300100572628631" } } } } ], "hasMore": true }