reference

Custom Fields

3 endpoints

POST/api/v3/custom-field

Create Custom Fields

Roles: SYSADMIN ADMIN ACCOUNT_ADMIN

Request body

CustomFieldDto

entities string[]
entity string
entityCode stringDEFAULT PROJECT TASK USER ORGANIZATION ORG_UNIT GLOSSARY PAYABLE INVOICE TRANSLATION_MEMORY
multivalueDefault string[]
name string
sameNameEntities string[]
scope CustomFieldScope
scopeNames map<string, string>
type stringBOOL TEXT NUMERIC MULTIVALUE FREE_TEXT
uuid string (uuid)
value string
values string[]

Responses

200 OK

Request

curl -X POST 'https://app.wxrks.com/api/v3/custom-field' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "entities": [
    "DEFAULT"
  ],
  "entity": "string",
  "entityCode": "DEFAULT",
  "multivalueDefault": [
    "string"
  ],
  "name": "string",
  "sameNameEntities": [
    "string"
  ],
  "scope": {
    "entityExcludedUsers": [],
    "entityGlossaries": [],
    "entityMemories": [],
    "entityOrgUnitMembers": [],
    "entityOrgUnits": [],
    "entityOrganizations": [],
    "entityUserRoles": [],
    "fillExcludedUsers": [],
    "fillOrgUnits": [],
    "fillRoles": [],
    "recordOrgUnits": [],
    "recordTypes": [],
    "viewExcludedUsers": [],
    "viewOrgUnits": [],
    "viewRoles": []
  },
  "scopeNames": {},
  "type": "BOOL",
  "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "value": "string",
  "values": [
    "string"
  ]
}'

PUT/api/v3/custom-field/entity/{entityType}/{entityUUID}

Update Custom Fields

path parameters

entityTyperequired string
entityUUIDrequired string (uuid)

Request body

map<string, object>[]

Responses

200 OK

map<string, object>[]

Request

curl -X PUT 'https://app.wxrks.com/api/v3/custom-field/entity/{entityType}/{entityUUID}' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '[]'

Response 200

[
  {}
]

GET/api/v3/custom-field/list

List Custom Fields

Requires one of: USER_view_custom_fields USER_edit_custom_fields

query parameters

name string
types string[]
entities string[]
value string
entityOrganizations string[]
entityOrgUnits string[]
entityGlossaries string[]
entityMemories string[]
entityOrgUnitMembers string[]
entityUserRoles string[]
entityExcludedUsers string[]
recordOrgUnits string[]
viewOrgUnits string[]
viewRoles string[]
viewExcludedUsers string[]
fillOrgUnits string[]
fillRoles string[]
fillExcludedUsers string[]
sort string
page integer
Page to return, starting at 0.
size integer
Items per page.

Responses

200 OK

PageCustomFieldDto

content CustomFieldDto[]
empty boolean
first boolean
last boolean
number integer
numberOfElements integer
pageable PageableObject
size integer
sort SortObject
totalElements integer (int64)
totalPages integer

Request

curl -X GET 'https://app.wxrks.com/api/v3/custom-field/list' \
  -H "X-AUTH-TOKEN: $WXRKS_TOKEN"

Response 200

{
  "content": [
    {}
  ],
  "empty": false,
  "first": false,
  "last": false,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": false,
    "sort": {},
    "unpaged": false
  },
  "size": 0,
  "sort": {
    "empty": false,
    "sorted": false,
    "unsorted": false
  },
  "totalElements": 0,
  "totalPages": 0
}