Customfieldconfigurations

Get CustomFieldConfigurations

GEThttps://api.sandbox.younium.com/CustomFieldConfigurations

Authorization

oauth2

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of CustomFieldConfigurationResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/CustomFieldConfigurations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "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",
      "fieldType": {},
      "entity": {},
      "list": "text",
      "typeEntity": {},
      "entityObject": "text"
    }
  ]
}

Create CustomFieldConfiguration

POSThttps://api.sandbox.younium.com/CustomFieldConfigurations

Authorization

oauth2

Header parameters

Body

application/json

fieldType*all of

entityall of

keynullable string

namenullable string

defaultValuenullable string

listnullable all of

typeEntitynullable all of

Response

201400401403

The CustumFieldConfiguration for the request.

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/CustomFieldConfigurations', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "fieldType": {}
    }),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Get CustomFieldConfiguration by Id

GEThttps://api.sandbox.younium.com/CustomFieldConfigurations/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403

Success

Body

application/json

idstring (uuid)

keynullable string

namenullable string

defaultValuenullable string

fieldTypeall of

entityall of

listnullable string

typeEntitynullable all of

entityObjectnullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/CustomFieldConfigurations/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

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

Update CustomFieldConfiguration by Id

PATCHhttps://api.sandbox.younium.com/CustomFieldConfigurations/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/merge-patch+json

fieldTypenullable all of

entitynullable all of

keynullable string

namenullable string

defaultValuenullable string

listnullable all of

typeEntitynullable all of

Response

200400401403

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/CustomFieldConfigurations/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/merge-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Get CustomFieldConfiguration by Entity and Key

GEThttps://api.sandbox.younium.com/CustomFieldConfigurations/{entity}/{key}

Authorization

oauth2

Path parameters

entity*string

key*string

Header parameters

Response

200400401403

Success

Body

application/json

idstring (uuid)

keynullable string

namenullable string

defaultValuenullable string

fieldTypeall of

entityall of

listnullable string

typeEntitynullable all of

entityObjectnullable string

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/CustomFieldConfigurations/{entity}/{key}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

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

Update CustomFieldConfiguration by Entity and key.

PATCHhttps://api.sandbox.younium.com/CustomFieldConfigurations/{entity}/{key}

Authorization

oauth2

Path parameters

entity*string

key*string

Header parameters

Body

application/merge-patch+json

fieldTypenullable all of

entitynullable all of

keynullable string

namenullable string

defaultValuenullable string

listnullable all of

typeEntitynullable all of

Response

200400401403

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/CustomFieldConfigurations/{entity}/{key}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/merge-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

---