UserDescription

the UserDescription API

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource with given ID was not found

application/json

get

/erp/user-details/{id}

HTTPcURLJavaScriptPython

GET /api/erp/user-details/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:44:51.110Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:44:51.110Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "accountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "customUserDetailFields": {},
  "parameter": "text",
  "fields": "text"
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

customUserDetailFieldsobjectOptional

Search-Dialog

parameterstringRequired

parameter

fieldsstringOptional

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/erp/user-details/{id}

HTTPcURLJavaScriptPython

PUT /api/erp/user-details/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "version": "text",
  "info": {},
  "id": "text",
  "userRef": {
    "id": "text"
  },
  "accountRef": {
    "id": "text"
  },
  "customUserDetailFields": {},
  "parameter": "text",
  "fields": "text"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:44:51.110Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:44:51.110Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "accountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "customUserDetailFields": {},
  "parameter": "text",
  "fields": "text"
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete

/erp/user-details/{id}

HTTPcURLJavaScriptPython

DELETE /api/erp/user-details/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

Create new Resource

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

customUserDetailFieldsobjectOptional

Search-Dialog

parameterstringRequired

parameter

fieldsstringOptional

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

post

/erp/user-details

HTTPcURLJavaScriptPython

POST /api/erp/user-details HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 154

{
  "version": "text",
  "info": {},
  "id": "text",
  "userRef": {
    "id": "text"
  },
  "accountRef": {
    "id": "text"
  },
  "customUserDetailFields": {},
  "parameter": "text",
  "fields": "text"
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:44:51.110Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:44:51.110Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "accountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "customUserDetailFields": {},
  "parameter": "text",
  "fields": "text"
}

get

Path parameters

idinteger · int64Required

user id

Responses

200

OK

application/json

get

/erp/user-details/user-id/{id}

HTTPcURLJavaScriptPython

GET /api/erp/user-details/user-id/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:44:51.110Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:44:51.110Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "userRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "accountRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "customUserDetailFields": {},
  "parameter": "text",
  "fields": "text"
}