Customfieldconfigurations

Get CustomFieldConfigurations

get

/CustomFieldConfigurations

Authorizations

Query parameters

Filterstring

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystring

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-time

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 11/01/2024 00:00:00

ModifiedBeforestring · date-time

Apply a separate filter to only get records that has been modified Before the specified date time.

Example: 11/01/2024 00:00:00

PageSizeinteger · int32

Page Size

Example: 20

PageNumberinteger · int32

Page Number

Example: 1

Header parameters

api-versionstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.younium.com/CustomFieldConfigurations'

200

400

401

403

200

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "key": "text",
      "name": "text",
      "defaultValue": "text",
      "list": "text",
      "entityObject": "text",
      "fieldType": "Text",
      "entity": "Account",
      "typeEntity": "Account"
    }
  ]
}

Success

Create CustomFieldConfiguration

post

/CustomFieldConfigurations

Authorizations

Header parameters

api-versionstring

Body

keystring | nullable

namestring | nullable

defaultValuestring | nullable

fieldTypeall ofrequired

entityall of

listall of | nullable

typeEntityall of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.younium.com/CustomFieldConfigurations' \
  --header 'Content-Type: application/json' \
  --data '{"fieldType":"Text","entity":"Account","list":{},"typeEntity":"Account"}'

201

400

401

403

201

No body

The CustumFieldConfiguration for the request.

Get CustomFieldConfiguration by Id

get

/CustomFieldConfigurations/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.younium.com/CustomFieldConfigurations/{id}'

200

400

401

403

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "text",
  "name": "text",
  "defaultValue": "text",
  "list": "text",
  "entityObject": "text",
  "fieldType": "Text",
  "entity": "Account",
  "typeEntity": "Account"
}

Success

Update CustomFieldConfiguration by Id

patch

/CustomFieldConfigurations/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

keystring | nullable

namestring | nullable

defaultValuestring | nullable

fieldTypeall of | nullable

entityall of | nullable

listall of | nullable

typeEntityall of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.younium.com/CustomFieldConfigurations/{id}' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '{"fieldType":"Text","entity":"Account","list":{},"typeEntity":"Account"}'

200

400

401

403

200

No body

Success

Get CustomFieldConfiguration by Entity and Key

get

/CustomFieldConfigurations/{entity}//{key}

Authorizations

Path parameters

entitystringrequired

keystringrequired

Header parameters

api-versionstring

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.younium.com/CustomFieldConfigurations/{entity}/{key}'

200

400

401

403

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "key": "text",
  "name": "text",
  "defaultValue": "text",
  "list": "text",
  "entityObject": "text",
  "fieldType": "Text",
  "entity": "Account",
  "typeEntity": "Account"
}

Success

Update CustomFieldConfiguration by Entity and key.

patch

/CustomFieldConfigurations/{entity}//{key}

Authorizations

Path parameters

entitystringrequired

keystringrequired

Header parameters

api-versionstring

Body

keystring | nullable

namestring | nullable

defaultValuestring | nullable

fieldTypeall of | nullable

entityall of | nullable

listall of | nullable

typeEntityall of | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.younium.com/CustomFieldConfigurations/{entity}/{key}' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '{"fieldType":"Text","entity":"Account","list":{},"typeEntity":"Account"}'

200

400

401

403

200

No body

Success

---