PayItemTag

Returns pay item setup tags with their groups

This call returns a list of pay item setup tags with their groups.

Securitybearer
Request
query Parameters
businessUnitId
required
string <uuid>

The business unit ID you are requesting setup filters for.

modifiedSince
string <date-time>
Responses
get/api/v1/payItemSetupFilters
Request samples 
Response samples 
application/json
[
  • {
    }
]
Returns pay items with associated setup tags
This call will return a list of pay items and their associated setup tags for the specified pay items, jobs, tags or modified since date.


Securitybearer 
Request 
Request Body schema: 
Set of filters for the request.


payItemIds
Array of strings or null <uuid> 
List of Pay Item Ids.


 
jobIds
Array of strings or null <uuid> 
List of Job Ids.


 
tagIds
Array of strings or null <uuid> 
List of Tag Ids.


 
modifiedSince
string or null <date-time> 
The date since the last update.


 
cursor
string or null
Optional.
When there are additional results, the metadata nextCursor field should be passed to retrieve the next page of results.


 
limit
integer or null <int32> 
The maximum number of results that should be returned.


 
Responses 
post/api/v1/payItemTags/advancedRequest
Request samples 
{
  • "payItemIds": [
    ],
  • "jobIds": [
    ],
  • "tagIds": [
    ],
  • "modifiedSince": "2019-08-24T14:15:22Z",
  • "cursor": "string",
  • "limit": 0
}
Response samples 
application/json
[
  • {
    }
]
Deletes pay item - tag relationships.
Securitybearer 
Request 
query Parameters
jobId
string <uuid> 
The job ID.


 
payItemId
string <uuid> 
The pay item ID.


 
tagId
string <uuid> 
The tag ID.


 
Responses 
204
No Content


400
Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


delete/api/v1/payItemTags
Request samples 
Upserts pay item setup tags
This call creates and updates setup tags associated with pay items.


Securitybearer 
Request 
Request Body schema: 
required
The list of pay items and associated setup tag to be created or updated.


 Array ([ 1 .. 1000 ] items)
payItemId
required
string <uuid> 
The pay item id.


 
tagId
required
string <uuid> 
The tag id.


 
Responses 
204
No Content


400
Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.


401
Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.


403
Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.


patch/api/v1/payItemTags
Request samples 
[
  • {
    }
]