Sign in

v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
companyAttributes

partially update one existing companyAttribute

Partially update one existing companyAttribute

patch/api/serviceorganizations/companyAttributes/{identifier}

Path parameters

identifierstring uuid required

companyAttribute unique identifier

Request body

uuidstring uuid
createdAtstring date-time
createdBystring uuid
lastUpdatedAtstring date-time
lastUpdatedBystring uuid
lastUpdatedByAudiencestring
lastUpdatedByAudienceUuidstring uuid
lastUpdatedByImpersonatedBystring uuid
lastUpdatedByCompanyUuidstring uuid
lastUpdatedByEnterpriseUuidstring uuid
labelstring required
keystring
dataType'string' | 'number' | 'date' | 'boolean' | 'select' | 'address' | 'media' | 'signature' | 'complianceDocument' required
descriptionstring
hireUuidstring uuid
readOnlyboolean
attachedToModel'location' | 'locationGroup' | 'job' | 'opening'

Example request

{
  "uuid": "8223636c5-47f4-43cc-963a-1d1d4e22b665",
  "createdAt": "2021-05-05T01:02:03.924Z",
  "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
  "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
  "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
  "lastUpdatedByAudience": "employer",
  "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
  "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
  "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
  "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
  "label": "Attribute 1",
  "key": "attribute_1",
  "dataType": "string",
  "description": "The first attribute in my company",
  "hireUuid": "123e4567-e89b-12d3-a456-426614174232",
  "attachedToModel": "location"
}

Response

updated companyAttribute. Wrapped in a JsonAPI root response.

Example response

{
  "data": {
    "uuid": "8223636c5-47f4-43cc-963a-1d1d4e22b665",
    "createdAt": "2021-05-05T01:02:03.924Z",
    "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
    "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
    "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
    "lastUpdatedByAudience": "employer",
    "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
    "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
    "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
    "label": "Attribute 1",
    "key": "attribute_1",
    "dataType": "string",
    "description": "The first attribute in my company",
    "hireUuid": "123e4567-e89b-12d3-a456-426614174232",
    "attachedToModel": "location"
  },
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}