List Entity Fields

post/metadata.describe/{TypeCode}

Retrieves information (data type, maximum length, possible values, whether the field is required, etc.) about fields of the specified entity.

Securitybasic or X-PriceFx-jwt
Request
path Parameters
TypeCode
required
string

Enter the type code of the entity you want to retrieve information for. See the list of Type Codes in the Pricefx Knowledge Base article.

Possible values: "ACTT" "AI" "AP" "APIK" "BD" "BPT" "BR" "C" "CA" "CAM" "CDESC" "CF" "CFS" "CFT" "CH" "CL" "CLLI" "CLLIAM" "CLR" "CLT" … 182 more
Example: P
query Parameters
name
string

The name of the PX or CX category.

lookupTableId
string

The ID of the Company Parameters table when retrieving MLTV (MatrixLookupTableValue).

Responses
200

OK

Response Schema: application/json
object
node
string non-empty
Array of objects non-empty unique
Array (non-empty)
name
string non-empty

The name of the entity.

typeCode
string non-empty

The type code of the entity.

massEditable
boolean

When set to true, the multiple records at once can be edited in this entity.

bulkLoadable
boolean

When set to true, a bulk data can be loaded to the entity using, for example, a /loaddata/{TypeCode} endpoint.

businessKey
Array of objects

Fields that make up a business key.

fields
object

Entity fields and corresponding properties.

status
number
Request samples 
Response samples 
application/json
{
  • "response": {
    • "node": "string",
    • "data": [
      • {
        • "name": "string",
        • "typeCode": "string",
        • "massEditable": true,
        • "bulkLoadable": true,
        • "businessKey": [
          ],
        • "fields": { }
        }
      ],
    • "status": 0
    }
}