Skip to main content
PUT
/
api2
/
v1
/
customFields
/
{fieldUid}
Edit custom field
curl --request PUT \
  --url https://cloud.memsource.com/web/api2/v1/customFields/{fieldUid} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "allowedEntities": [
    "PROJECT"
  ],
  "required": true,
  "description": "<string>",
  "addOptions": [
    "<string>"
  ],
  "removeOptions": [
    {
      "uid": "<string>"
    }
  ],
  "deprecateOptions": [
    {
      "uid": "<string>"
    }
  ],
  "undeprecateOptions": [
    {
      "uid": "<string>"
    }
  ]
}'
{
  "uid": "<string>",
  "name": "<string>",
  "type": "MULTI_SELECT",
  "allowedEntities": [
    "PROJECT"
  ],
  "options": {
    "truncatedOptions": [
      {
        "uid": "<string>",
        "value": "<string>",
        "deprecated": true,
        "used": true
      }
    ],
    "remainingCount": 123
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": {
    "firstName": "<string>",
    "lastName": "<string>",
    "userName": "<string>",
    "email": "<string>",
    "role": "SYS_ADMIN",
    "id": "<string>",
    "uid": "<string>"
  },
  "lastModified": "2023-11-07T05:31:56Z",
  "lastModifiedBy": {
    "firstName": "<string>",
    "lastName": "<string>",
    "userName": "<string>",
    "email": "<string>",
    "role": "SYS_ADMIN",
    "id": "<string>",
    "uid": "<string>"
  },
  "requiredFrom": "2023-11-07T05:31:56Z",
  "required": true,
  "description": "<string>"
}

Path Parameters

fieldUid
string
required

Body

application/json
name
string
required
Maximum length: 255
allowedEntities
enum<string>[]
required
required
boolean
description
string
Maximum length: 500
addOptions
string[]
removeOptions
object[]
deprecateOptions
object[]
undeprecateOptions
object[]

Response

successful operation

uid
string
name
string
type
enum<string>
Available options:
MULTI_SELECT,
SINGLE_SELECT,
STRING,
NUMBER,
URL,
DATE
allowedEntities
enum<string>[]
options
object
createdAt
string<date-time>
createdBy
object
lastModified
string<date-time>
lastModifiedBy
object
requiredFrom
string<date-time>
required
boolean
description
string
I