Unicat API Reference

Up - API Reference - Home

/api/p/<project gid>/fields/metadata/clear

Requires JWT

Remove a metadata field from a field.

If the metadata field name wasn't set on this field, the field is returned unchanged.

Request

POST /api/p/<project gid>/fields/metadata/clear
Authorization: Bearer <JWT>

{
    "field": "<field gid>",
    "name": "group.code",
}

field gid of the field to remove the metadata field from
name name for the metadata field

Success response

Authorization: <JWT>

{
    "success": true,
    "result": {
        "field": "<field gid>"
    },
    "data": {
        "fields": {
            "<field gid>": {…}
        }
    }
}

result

field the field with the metadata field removed - this is usually a working copy.

data

fields Field info with name, type, options, metadata.

Error responses

400 Bad request - missing parameters or wrong type or value
401 Unauthorized - missing or expired JWT
403 Forbidden - not a member of this project
422 Unprocessable entity - can't work with this item