API Specifications
What's NewUKG.comMarketplaceUKG Pro status

Partial update of an employee document

patch
https://{hrsd-dochub-service}/hrsd/dochub/v1/employee-documents/

Partially update an Employee Document. All fields are optional.

Path Params
string
required

The Document ID

Body Params

Document and options

string

ID of the Employee for whom the Document is uploaded. Mandatory if externalEmployeeId is not provided

string

External ID of the Employee for whom the Document is uploaded

string
required

Document Category ID, the document belongs to

string

Title of the Document

date-time

Date explicitly passed at the Document upload via the API. If available, it will be used instead of the creation date to sort the Document

organizationIds
array of strings

Organization IDs, inherited from the employee, the Document is attached to. When uploading a document, if this parameter is specified in the call, the document will be associated with all of the organizations passed. Note: the employee must belong to these organizations via an active or an inactive registration references. If this parameter is not specified, the document will be associated with all of the employee’s active organizations for current employees or with all of the employee’s inactive organizations for terminated employees

organizationIds
metadata
array of objects
metadata
string

External document reference to help identify the Document in external tools or filing systems

boolean
Defaults to false

Is the External document reference for a site unique (true)? or not (false)

boolean

Has the Document been deleted (true)? or not (false)

date

Real Expiration Date for the document. If the Expiration Date is set in the past then the document will be marked as expired and will no longer be valid. If the Expiration Date is set to null, it means document doesn't have expiration at all.

date

New Retention Period for the document. If the Retention Period is set in the past then the document will be marked as Past retention period. If the Retention Period is set to null, the Retention Period inherited from the document category will be used.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Document

Updated 5 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json

Updated 5 months ago