Get the top-level KM Record Schema details

Top-level Record Schema details

SecurityBearerAuth or ApiKeyAuth

Request

path Parameters

km_id required	string Example: open-purchase-requisition.purchase-requisition-km
record_id required	string Example: MATERIALS

query Parameters

sort

string

Defines the strategy to proceed for case insensitive sorting. It must be just one field, and it should start with "+" to apply ASC order or "-" to apply DESC order. Non prefix will sort as ASC. Non existing field at the header will throw an error. Note: The sort operation is only applied in the fields section for id, name, description, shortDisplayName and internalNote.

Example: sort=field1

Responses

200

Top-level Record Schema details

400

Bad Request.

401

Unauthorized access.

403

Forbidden.

404

The specified resource was not found

429

Too Many Requests.

500

Internal Server Error.

503

Service Unavailable.

get/api/knowledge-models/{km_id}/records/{record_id}

Request samples

curl
JavaScript
Java
Python
PHP

Response samples

application/json

{"fields": [{"id": "material_name",
"name": "Material Name",
"description": "Materials name that have been purchased.",
"shortDisplayName": "Materials",
"internalNote": "Materials",
"type": "string",
"format": "",
"unit": ""
},
{"id": "material_number",
"name": "Material Number",
"description": "Materials number that have been purchased.",
"shortDisplayName": "Materials",
"internalNote": "Materials",
"type": "string",
"format": "",
"unit": ""
},
{"id": "material_group",
"name": "Material Group",
"description": "Materials group that have been purchased.",
"shortDisplayName": "Materials",
"internalNote": "Materials",
"type": "string",
"format": "",
"unit": ""
}
],
"id": "MATERIALS",
"name": "Materials",
"description": "Materials that have been purchased.",
"shortDisplayName": "Materials",
"internalNote": "Materials"
}