Skip to navigation

Get DocumentPartRegistrationTableCreateEntities by ID

Beta
Get a single DocumentPartRegistrationTableCreateEntities by ID.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

document_part_registration_table_create_entities_idstringRequired
ID of the DocumentPartRegistrationTableCreateEntities.

Headers

EARLY-ACCESSstringOptional

Set to true to access beta operations via /api/v3.

Query parameters

returninglist of stringsOptional

Comma-separated list of top-level fields to include in each returned item. Cannot overlap with omit.

omitlist of stringsOptional

Comma-separated list of top-level fields to omit from each returned item. Cannot overlap with returning.

Response

OK
__typenamestringOptional
columnDefinitionslist of objectsOptional
createdAtstringOptionalformat: "datetime"
entitySchemaobject or nullOptional
idstringOptional
indentationintegerOptional
isEvaluatedbooleanOptional
isSubmittablebooleanOptional
modifiedAtstringOptionalformat: "datetime"
modifierobject or nullOptional
namestringOptional
namingStrategyenumOptional
registrationDestinationFolderobject or nullOptional

The folder where newly registered entities are placed. When the table is configured to inherit from the entry, this resolves to the entry’s project folder. Returns null when the table is configured for no folder, when the destination cannot be determined (e.g. a template), or when the caller lacks read permission on the folder.

rowCountintegerOptional
rowsstringOptionalformat: "uri"
submissionStatusenumOptional
Allowed values:
versionMetadataobjectOptional
Version metadata for a document such as an entry, template, or subtemplate. Identifies a specific content revision and records when that revision was produced. Use this to detect changes, pin a revision, or reference a particular version without loading the full version record.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error