Page Comparison

• tenant – User tenant.
• project_id – Project identifier.

Data is passed in as a JSON object.

Valid object keys:

• name – The name of the facet. This is the name with which the facet is referenced in an item's keyword list.
• display_name – The name with which that facet is displayed to the user.
• data_type – The facet's data type. See the section Data Types below for the available data types.
• visible – Boolean indicating whether the facet is visible to the user.
• group_name – The group under which this facet is displayed.

Only the name key is required. All other keys are optional.

Example request body:

{
    "display_name": "Comment Count",
    "name": "comment_count",
    "data_type": "int",
    "group_name": "Metadata",
    "visible": true
}

• 201 – Facet created.
• 409 – A facet with the same name already exists.

See also Common Status Codes.

The created facet.

{
    "display_name": "Comment Count",
    "name": "comment_count",
    "data_type": "int",
    "group_name": "Metadata",
    "visible": true,
    "id": "a665d30abd88e397251bce536664bcdbfb8163c874459eebc813b42d7fc36def"
}

• tenant – User tenant.
• project_id – Project identifier.
• facet_id – Facet identifier.

• 200 – Facet returned.

See also Common Status Codes.

The facet.

{
    "display_name": "comment_count",
    "name": "comment_count",
    "data_type": "int",
    "group_name": "By field",
    "visible": true,
    "id": "a665d30abd88e397251bce536664bcdbfb8163c874459eebc813b42d7fc36def"
}