replace one customAttribute which exists or not

URL Expired

The URL for this request expired after 30 days.

Identifier

• uuid: required
• customAttribute unique identifier
• uuid
• companyUuid: uuid
• Company UUID
• label: string (required)
• key: string
• dataType: string (enum required)
  • enum values: string, number, date, boolean, select, address, media, signature, complianceDocument
• description: string
• options: array of objects

Options

• resource: string
• resourceIdentifier: uuid
• readOnly: boolean (Defaults to false)
  • If true, this attribute cannot be modified. Can only be set by system.
• hidden: boolean (Defaults to false)
  • If true, this attribute won't be shown. Can only be set by system.
• protected: boolean (Defaults to false)
  • If true, this attribute can only be accessed by users with certain rights.
• hireDataKeyId: integer
  • The ID of the hire data key

Response Codes

• 202: customAttribute replaced. Wrapped in a JsonAPI root response.
• 500: default error response

Example Request

curl --request PUT \
     --url https://services.fountain.com/api/serviceworkforce/customAttributes/identifier \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '\n{\n  "dataType": "string",\n  "readOnly": false,\n  "hidden": false,\n  "protected": false\n}\n'  

Try It!

Click Try It! to start a request and see the response here! Or choose an example:

• application/json

Updated

About 2 months ago