post /rest/api/metaobjects
Creates a Metaobject resource.
Creates a metaobject - one record of a definition . Reference the definition, give it a handle (a unique slug within its type), and supply the fields values. Each field is validated against the definition’s fieldDefinitions.
Name Type Required Description X-Flowkiwi-Organization-Idstringrequired The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.
Request body Property Type Required Description definitionMetaobjectDefinition.MetaobjectDefinitionCreateInputrequired The MetaobjectDefinition (IRI) this metaobject is a record of. Show definition fields Property Type Required Description typestringrequired namestringrequired descriptionstring | null- displayNameFieldstring | null- The key of the field definition used as the display name for records of this type. Optional - when omitted it is null and records have no derived display name. When set, it must match the key of one of this definition's fieldDefinitions, otherwise the request is rejected with 422. fieldDefinitionsEmbeddedMetaobjectFieldDefinitionResource[]- The field definitions that make up this metaobject definition. Show fieldDefinitions fields Property Type Required Description keystringrequired The field key, unique within the definition (referenced by metaobject fields). namestringrequired The human-readable name of the field. descriptionstring | null- An optional description of the field. typestringrequired The field data type, as an IRI to the field-type resource. requiredboolean- Whether a value for this field is required on metaobjects of the definition. validationsEmbeddedMetaobjectFieldDefinitionValidationResource[]- The validation rules applied to values of this field.
handlestringrequired The metaobject's unique slug within its definition type. status"DRAFT" | "ACTIVE"- The publication status of the metaobject. fieldsMetaobjectFieldInput[]- The field values of the metaobject, one entry per field definition. Show fields fields Property Type Required Description keystringrequired valuestring | null-
Response 201 - Metaobject resource created
Format JSON-LD JSON Property Type Required Description @contextobject- @idstringrequired @typestringrequired idstring- The resource's unique identifier (UUID). definitionstring- The MetaobjectDefinition (IRI) this metaobject is a record of. handlestring- The metaobject's unique slug within its definition type. status"DRAFT" | "ACTIVE"- The publication status of the metaobject. displayNamestring | null- The human-readable label, derived from the field named by the definition's displayNameField.
Property Type Required Description idstring- The resource's unique identifier (UUID). definitionstring- The MetaobjectDefinition (IRI) this metaobject is a record of. handlestring- The metaobject's unique slug within its definition type. status"DRAFT" | "ACTIVE"- The publication status of the metaobject. displayNamestring | null- The human-readable label, derived from the field named by the definition's displayNameField. fieldsEmbeddedMetaobjectFieldResource[]- The field values of the metaobject, one entry per field definition. Show fields fields Property Type Required Description keystring- The field key (matches a field definition key). valuestring | null- The field value, stored as a string regardless of the field type. typestring- The field data type, as an IRI to the field-type resource. metaobjectMetaobject[]- Show metaobject fields Property Type Required Description idstring- The resource's unique identifier (UUID). definitionstring- The MetaobjectDefinition (IRI) this metaobject is a record of. handlestring- The metaobject's unique slug within its definition type. status"DRAFT" | "ACTIVE"- The publication status of the metaobject. displayNamestring | null- The human-readable label, derived from the field named by the definition's displayNameField. fieldsEmbeddedMetaobjectFieldResource[]- The field values of the metaobject, one entry per field definition. createdAtstring- The date and time when the resource was created (ISO 8601 format). updatedAtstring- The date and time when the resource was last modified (ISO 8601 format).
createdAtstring- The date and time when the resource was created (ISO 8601 format). updatedAtstring- The date and time when the resource was last modified (ISO 8601 format).
Errors 400 - Invalid input
Format JSON-LD JSON Property Type Required Description @contextobject- @idstringrequired @typestringrequired titlestring | null- A short, human-readable summary of the problem. detailstring | null- A human-readable explanation specific to this occurrence of the problem. statusnumber | null- instancestring | null- A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. typestring- A URI reference that identifies the problem type
Property Type Required Description titlestring | null- A short, human-readable summary of the problem. detailstring | null- A human-readable explanation specific to this occurrence of the problem. statusnumber | null- instancestring | null- A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. typestring- A URI reference that identifies the problem type
403 - Access denied. The caller is missing one or more identity permissions required for this operation.
Content-Type: application/problem+json
Property Type Required Description @contextobject- @idstringrequired @typestringrequired typestring- titlestring- statusinteger- detailstring- missingPermissionsstring[]- Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.
422 - An error occurred
Format JSON-LD JSON Property Type Required Description @contextobject- @idstringrequired @typestringrequired statusinteger- violationsobject[]- Show violations fields Property Type Required Description propertyPathstringrequired The property path of the violation messagestringrequired The message associated with the violation codestring- The code of the violation hintstring- An extra hint to understand the violation payloadobject- The serialized payload of the violation
detailstring- typestring- titlestring | null- instancestring | null-
Property Type Required Description statusinteger- violationsobject[]- Show violations fields Property Type Required Description propertyPathstringrequired The property path of the violation messagestringrequired The message associated with the violation codestring- The code of the violation hintstring- An extra hint to understand the violation payloadobject- The serialized payload of the violation
detailstring- typestring- titlestring | null- instancestring | null-
