SAsalussafety
Metadata

Update UDF Labels

Update the labels for user defined fields on project

This endpoint will ignore any fields that are empty; only fields with values will be updated. If the value is set to null, it will be cleared.

patch/v1/meta/labels/{entity}/

Request

  • Base URL
    https://developer.beta.salussafety.io
  • URL
    https://developer.beta.salussafety.io/v1/meta/labels/{entity}/
  • Auth
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: https://guardian.beta.salussafety.io/token
    • or OAuth 2
      Authorization code: https://guardian.beta.salussafety.io/authorize
      Token URL: https://guardian.beta.salussafety.io/token

Path parameters

entity'project' required

Entities with User Defined Fields

Request body

udf1Labelstring nullable

Label for the customer-defined metadata found in udf1

udf2Labelstring nullable

Label for the customer-defined metadata found in udf2

udf3Labelstring nullable

Label for the customer-defined metadata found in udf3

Example request

{
  "udf1Label": "Division",
  "udf2Label": "Location",
  "udf3Label": "Team"
}

Response

Successful Response

errorboolean

A boolean error indicator.

messagestring nullable

Optional message.

Example response

{
  "data": {
    "udf1Label": "Division",
    "udf2Label": "Location",
    "udf3Label": "Team"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.