/api/v1/collection

Collections can store links to objects. It is possible to link other objects from fylr as well as foreign objects, unknown to fylr. Object links must be unique. Linked objects can be manually sorted.

POST /collection — Create or update a collection.

Create or update a collection.

post

• The user needs BAG_CREATE in the parent collection to create a collection.
• The user needs BAG_WRITE to update a collection.
• The _owner is set to the owner of the parent.
• To set _private_acl or _acl the user needs BAG_ACL.
• New ACL items with send_email_notification will sent out and email.
• An update is performed if the payload contains a _version greater 1.
• Moving a collection to a new parent requires BAG_CREATE in the new parent and BAG_ACL in the current collection. When moving a collection, the owner is automatically set to the owner of the parent. This includes all child collections.
• COLLECTION_INSERT / COLLECTION_UPDATE event is written.

Differs from easydb 5: the children_allowed flag is stored but has no effect. easydb 5 enforces it, rejecting an attempt "to create or move a collection under a collection that does not allow children" with the Collection Does Not Allow Children error; fylr raises no such error.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Query parameters

allow_invalid_aclstring · booleanOptional

Allow storing the collection even if the owner doesn't have the necessary permissions for all objects to share the rights defined in the _acl property of the collection. The _invalid_acl flag will be set, if the user doesn't have sufficient permissions to share all objects of the collection. The user needs the permission BAG_ACL for the collection in order to use this parameter.

Differs from easydb 5: this confirmation is driven by the boolean allow_invalid_acl parameter. easydb 5 instead resolves the 202 confirmation with a collection_rights_policy query parameter; there is no allow_invalid_acl parameter in easydb 5.

background_invalid_aclstring · booleanOptional

If set, the invalid-ACL validity check (whether the collection owner may grant the rights of all linked objects) is not run inline. Instead a queued ACTION_COLLECTION_ACL_CHECK job is scheduled and the request returns immediately, before the check has resolved.

Header parameters

x-fylr-authorizationstringOptional

The access token in form of Bearer <token>. You can also use authorization which does the same. authorization is looked at first.

authorizationstringOptional

The access token in form of Bearer <token>.

Body

application/json

_basetypestring · enumOptionalPossible values:

_countnumber · int64Read-onlyOptional

The number of objects in this collection.

_count_recursivenumber · int64Read-onlyOptional

The number of objects in this collection and and all descendant collections (recursive).

_has_aclbooleanRead-onlyOptional

Flag that indicates that this collection has an active _acl (even if inherited).

_has_childrenbooleanRead-onlyOptional

Flag that inidicates if this collection has children. This flag is indpendent of the actual permissions of the user for that collection. So, if the user cannot access the only sub collection of this collection, the _has_children flag will still be set.

_has_remote_objectsbooleanRead-onlyOptional

Flag that inidicates if this collection contains at least one foreign collection object.

_levelbooleanRead-onlyOptional

Starting with 1, _level states the depth of the collection in the collection tree. The top level from the user's perspective is 3. The 1st level is the root collection, the 2nd level the user's top level collection which is a system collection and automatically created to hold all the user's collections underneath.

_private_aclbooleanOptional

Flag which indicates a private ACL. With this setting ACL from the parent are ignored (except for the items which set sticky.

_invalid_aclbooleanRead-onlyOptional

Collection can share permissions to other users. The owner of the collection must carry the grantable permission for each object in the collection in order to share the collection. fylr determines for the whole collection if sharing is allowed or not. If it is not allowed, the collection will be put in _invalid_acl: true state which disables the ACL attached to the collection.

_has_pinbooleanRead-onlyOptional

This flag indicates that the collection has a pin code. The actual pin code is only visible to system.root users and users with the BAG_ACL.

pin_okbooleanRead-onlyOptional

Flag to indicate that the pin was entered correctly for the current user. system.root and all users with the BAG_ACL permission will always see pin_ok.

_created_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was created.

_updated_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was updated.

Responses

200

The response contains the collection created, including the issued _id.

application/json

_basetypestring · enumOptionalPossible values:

_countnumber · int64Read-onlyOptional

The number of objects in this collection.

_count_recursivenumber · int64Read-onlyOptional

The number of objects in this collection and and all descendant collections (recursive).

_has_aclbooleanRead-onlyOptional

Flag that indicates that this collection has an active _acl (even if inherited).

_has_childrenbooleanRead-onlyOptional

Flag that inidicates if this collection has children. This flag is indpendent of the actual permissions of the user for that collection. So, if the user cannot access the only sub collection of this collection, the _has_children flag will still be set.

_has_remote_objectsbooleanRead-onlyOptional

Flag that inidicates if this collection contains at least one foreign collection object.

_levelbooleanRead-onlyOptional

Starting with 1, _level states the depth of the collection in the collection tree. The top level from the user's perspective is 3. The 1st level is the root collection, the 2nd level the user's top level collection which is a system collection and automatically created to hold all the user's collections underneath.

_private_aclbooleanOptional

Flag which indicates a private ACL. With this setting ACL from the parent are ignored (except for the items which set sticky.

_invalid_aclbooleanRead-onlyOptional

Collection can share permissions to other users. The owner of the collection must carry the grantable permission for each object in the collection in order to share the collection. fylr determines for the whole collection if sharing is allowed or not. If it is not allowed, the collection will be put in _invalid_acl: true state which disables the ACL attached to the collection.

_has_pinbooleanRead-onlyOptional

This flag indicates that the collection has a pin code. The actual pin code is only visible to system.root users and users with the BAG_ACL.

pin_okbooleanRead-onlyOptional

Flag to indicate that the pin was entered correctly for the current user. system.root and all users with the BAG_ACL permission will always see pin_ok.

_created_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was created.

_updated_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was updated.

202

The collection owner lacks a grantable right for a linked object and the caller has BAG_ACL. Re-send with allow_invalid_acl=true to store the collection with sharing disabled.

application/json

400

The request could not be processed. The code field of the response identifies which validation rejected the request.

application/json

401

No authenticated user. The request must carry a valid access token.

application/json

403

The authenticated user lacks a required BAG_* permission on the collection (or a required system right). See code for the specific reason.

application/json

{
  "collection": {
    "_id": 1,
    "_id_parent": 1,
    "_version": 1,
    "children_allowed": true,
    "objects_allowed": true,
    "is_system_collection": true,
    "webfrontend_props": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "displayname": {
      "de-DE": "Deutscher text",
      "en-US": "English text"
    },
    "description": {
      "de-DE": "Deutscher text",
      "en-US": "English text"
    },
    "create_object": {
      "objecttype": "text",
      "mask_id": 1,
      "pool_id": 1,
      "linked_pool_id": 1,
      "pool": {
        "_basetype": "pool",
        "pool": {
          "_version": 1,
          "lookup:_id_parent": {
            "reference": "system:root"
          },
          "reference": "testpool",
          "comment": "horst",
          "name": {
            "de-DE": "Testpool [DE]",
            "en-US": "Testpool [EN]"
          }
        }
      },
      "linked_pool": {
        "_basetype": "pool",
        "pool": {
          "_version": 1,
          "lookup:_id_parent": {
            "reference": "system:root"
          },
          "reference": "testpool",
          "comment": "horst",
          "name": {
            "de-DE": "Testpool [DE]",
            "en-US": "Testpool [EN]"
          }
        }
      },
      "eas_field": "text",
      "linked_object_pools": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "hierarchy_linked_object": {
        "field": "text"
      },
      "mapping": "standard",
      "mapping_recipe_configs": {
        "ANY_ADDITIONAL_PROPERTY": {
          "imageconverter:browserthumbs": {
            "params": {
              "size": 1200,
              "format": "webp",
              "resize_mode": "max"
            }
          },
          "imageconverter:preview_pool_watermark": {
            "params": {
              "size": 600,
              "format": "jpg"
            }
          }
        }
      },
      "recognize_series": false,
      "recognize_version": false,
      "update_search_field": "text",
      "update_mode": "insert",
      "update_policy": "create_version",
      "tags": [
        {
          "_id": 1,
          "displayname": {
            "de-DE": "Dogs"
          },
          "enabled": true,
          "displaytype": "detail",
          "sticky": true
        }
      ],
      "plugin": "text",
      "plugin_config": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    },
    "reference": "text",
    "shortname": "text",
    "type": "text",
    "pin_code": "text",
    "uuid": "text",
    "lookup:_id": {
      "reference": "text"
    },
    "lookup:_id_parent": {
      "reference": "text"
    }
  },
  "_basetype": "collection",
  "_count": 1,
  "_count_recursive": 1,
  "_create_object_compiled": {
    "objecttype": "text",
    "mask_id": 1,
    "pool_id": 1,
    "linked_pool_id": 1,
    "pool": {
      "_basetype": "pool",
      "pool": {
        "_version": 1,
        "lookup:_id_parent": {
          "reference": "system:root"
        },
        "reference": "testpool",
        "comment": "horst",
        "name": {
          "de-DE": "Testpool [DE]",
          "en-US": "Testpool [EN]"
        }
      }
    },
    "linked_pool": {
      "_basetype": "pool",
      "pool": {
        "_version": 1,
        "lookup:_id_parent": {
          "reference": "system:root"
        },
        "reference": "testpool",
        "comment": "horst",
        "name": {
          "de-DE": "Testpool [DE]",
          "en-US": "Testpool [EN]"
        }
      }
    },
    "eas_field": "text",
    "linked_object_pools": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "hierarchy_linked_object": {
      "field": "text"
    },
    "mapping": "standard",
    "mapping_recipe_configs": {
      "ANY_ADDITIONAL_PROPERTY": {
        "imageconverter:browserthumbs": {
          "params": {
            "size": 1200,
            "format": "webp",
            "resize_mode": "max"
          }
        },
        "imageconverter:preview_pool_watermark": {
          "params": {
            "size": 600,
            "format": "jpg"
          }
        }
      }
    },
    "recognize_series": false,
    "recognize_version": false,
    "update_search_field": "text",
    "update_mode": "insert",
    "update_policy": "create_version",
    "tags": [
      {
        "_id": 1,
        "displayname": {
          "de-DE": "Dogs"
        },
        "enabled": true,
        "displaytype": "detail",
        "sticky": true
      }
    ],
    "plugin": "text",
    "plugin_config": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "_generated_rights": {
    "create": {},
    "create_in_collection": {},
    "read": {},
    "write": {},
    "delete": {},
    "asset_upload": {},
    "asset_show": {},
    "asset_download": {},
    "mask": {},
    "link": {},
    "acl": {},
    "change_owner": {},
    "unlink": {},
    "bag_read": {},
    "bag_write": {},
    "bag_acl": {},
    "bag_delete": {},
    "bag_create": {},
    "owner": {}
  },
  "_has_acl": true,
  "_has_children": true,
  "_has_remote_objects": true,
  "_level": true,
  "_acl": [
    {
      "_id": 1,
      "who": {
        "_basetype": "user",
        "_owner": true,
        "_pool_contact": true,
        "user": {
          "_id": 1,
          "_version": 1,
          "type": "system",
          "_generated_displayname": "text",
          "login": "text",
          "frontend_language": "text"
        },
        "group": {
          "_id": 1,
          "_generated_displayname": "text"
        }
      },
      "sticky": true,
      "active": true,
      "_right_preset": 1,
      "when": {
        "from": "text",
        "to": "text"
      },
      "rights": {
        "ANY_ADDITIONAL_PROPERTY": {
          "_grantable": true,
          "allow_update_and_remove": true,
          "classes": [
            "text"
          ],
          "extensions": [
            "text"
          ],
          "versions": [
            "text"
          ],
          "limit": "text",
          "mask_ids": {
            "ANY_ADDITIONAL_PROPERTY": [
              "standard"
            ]
          },
          "column_ids": [
            1
          ],
          "objecttype_ids": [
            1
          ],
          "pool_ids": [
            1
          ]
        }
      },
      "tagfilter": {
        "any": [
          1
        ],
        "all": [
          1
        ],
        "not": [
          1
        ]
      },
      "send_email_notification": {
        "text": "text"
      }
    }
  ],
  "_private_acl": true,
  "_path": [
    {
      "_basetype": "collection",
      "collection": {
        "_id": 1,
        "_id_parent": 1,
        "_version": 1,
        "displayname": "text"
      }
    }
  ],
  "_invalid_acl": true,
  "_owner": {
    "_basetype": "user",
    "_owner": true,
    "_pool_contact": true,
    "user": {
      "_id": 1,
      "_version": 1,
      "type": "system",
      "_generated_displayname": "text",
      "login": "text",
      "frontend_language": "text"
    },
    "group": {
      "_id": 1,
      "_generated_displayname": "text"
    }
  },
  "objects": [
    {
      "_global_object_id": "text",
      "webfrontend_props": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "lookup:_global_object_id": {
        "_allow_defer": true,
        "_objecttype": "text",
        "_system_object_id": 1,
        "_uuid": "text",
        "additionalProperties": "text"
      }
    }
  ],
  "_hotfolder_upload_urls": [
    {
      "type": "webdav",
      "url": "text"
    }
  ],
  "_has_pin": true,
  "pin_ok": true,
  "_created_at": "text",
  "_updated_at": "text"
}

PUT /collection — Create or update a collection.

Create or update a collection.

put

• The user needs BAG_CREATE in the parent collection to create a collection.
• The user needs BAG_WRITE to update a collection.
• The _owner is set to the owner of the parent.
• To set _private_acl or _acl the user needs BAG_ACL.
• New ACL items with send_email_notification will sent out and email.
• An update is performed if the payload contains a _version greater 1.
• Moving a collection to a new parent requires BAG_CREATE in the new parent and BAG_ACL in the current collection. When moving a collection, the owner is automatically set to the owner of the parent. This includes all child collections.
• COLLECTION_INSERT / COLLECTION_UPDATE event is written.

Differs from easydb 5: the children_allowed flag is stored but has no effect. easydb 5 enforces it, rejecting an attempt "to create or move a collection under a collection that does not allow children" with the Collection Does Not Allow Children error; fylr raises no such error.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Query parameters

allow_invalid_aclstring · booleanOptional

Allow storing the collection even if the owner doesn't have the necessary permissions for all objects to share the rights defined in the _acl property of the collection. The _invalid_acl flag will be set, if the user doesn't have sufficient permissions to share all objects of the collection. The user needs the permission BAG_ACL for the collection in order to use this parameter.

Differs from easydb 5: this confirmation is driven by the boolean allow_invalid_acl parameter. easydb 5 instead resolves the 202 confirmation with a collection_rights_policy query parameter; there is no allow_invalid_acl parameter in easydb 5.

background_invalid_aclstring · booleanOptional

If set, the invalid-ACL validity check (whether the collection owner may grant the rights of all linked objects) is not run inline. Instead a queued ACTION_COLLECTION_ACL_CHECK job is scheduled and the request returns immediately, before the check has resolved.

Header parameters

x-fylr-authorizationstringOptional

The access token in form of Bearer <token>. You can also use authorization which does the same. authorization is looked at first.

authorizationstringOptional

The access token in form of Bearer <token>.

Body

application/json

_basetypestring · enumOptionalPossible values:

_countnumber · int64Read-onlyOptional

The number of objects in this collection.

_count_recursivenumber · int64Read-onlyOptional

The number of objects in this collection and and all descendant collections (recursive).

_has_aclbooleanRead-onlyOptional

Flag that indicates that this collection has an active _acl (even if inherited).

_has_childrenbooleanRead-onlyOptional

Flag that inidicates if this collection has children. This flag is indpendent of the actual permissions of the user for that collection. So, if the user cannot access the only sub collection of this collection, the _has_children flag will still be set.

_has_remote_objectsbooleanRead-onlyOptional

Flag that inidicates if this collection contains at least one foreign collection object.

_levelbooleanRead-onlyOptional

Starting with 1, _level states the depth of the collection in the collection tree. The top level from the user's perspective is 3. The 1st level is the root collection, the 2nd level the user's top level collection which is a system collection and automatically created to hold all the user's collections underneath.

_private_aclbooleanOptional

Flag which indicates a private ACL. With this setting ACL from the parent are ignored (except for the items which set sticky.

_invalid_aclbooleanRead-onlyOptional

Collection can share permissions to other users. The owner of the collection must carry the grantable permission for each object in the collection in order to share the collection. fylr determines for the whole collection if sharing is allowed or not. If it is not allowed, the collection will be put in _invalid_acl: true state which disables the ACL attached to the collection.

_has_pinbooleanRead-onlyOptional

This flag indicates that the collection has a pin code. The actual pin code is only visible to system.root users and users with the BAG_ACL.

pin_okbooleanRead-onlyOptional

Flag to indicate that the pin was entered correctly for the current user. system.root and all users with the BAG_ACL permission will always see pin_ok.

_created_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was created.

_updated_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was updated.

Responses

200

The response contains the collection created, including the issued _id.

application/json

_basetypestring · enumOptionalPossible values:

_countnumber · int64Read-onlyOptional

The number of objects in this collection.

_count_recursivenumber · int64Read-onlyOptional

The number of objects in this collection and and all descendant collections (recursive).

_has_aclbooleanRead-onlyOptional

Flag that indicates that this collection has an active _acl (even if inherited).

_has_childrenbooleanRead-onlyOptional

Flag that inidicates if this collection has children. This flag is indpendent of the actual permissions of the user for that collection. So, if the user cannot access the only sub collection of this collection, the _has_children flag will still be set.

_has_remote_objectsbooleanRead-onlyOptional

Flag that inidicates if this collection contains at least one foreign collection object.

_levelbooleanRead-onlyOptional

Starting with 1, _level states the depth of the collection in the collection tree. The top level from the user's perspective is 3. The 1st level is the root collection, the 2nd level the user's top level collection which is a system collection and automatically created to hold all the user's collections underneath.

_private_aclbooleanOptional

Flag which indicates a private ACL. With this setting ACL from the parent are ignored (except for the items which set sticky.

_invalid_aclbooleanRead-onlyOptional

Collection can share permissions to other users. The owner of the collection must carry the grantable permission for each object in the collection in order to share the collection. fylr determines for the whole collection if sharing is allowed or not. If it is not allowed, the collection will be put in _invalid_acl: true state which disables the ACL attached to the collection.

_has_pinbooleanRead-onlyOptional

This flag indicates that the collection has a pin code. The actual pin code is only visible to system.root users and users with the BAG_ACL.

pin_okbooleanRead-onlyOptional

Flag to indicate that the pin was entered correctly for the current user. system.root and all users with the BAG_ACL permission will always see pin_ok.

_created_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was created.

_updated_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was updated.

202

The collection owner lacks a grantable right for a linked object and the caller has BAG_ACL. Re-send with allow_invalid_acl=true to store the collection with sharing disabled.

application/json

400

The request could not be processed. The code field of the response identifies which validation rejected the request.

application/json

401

No authenticated user. The request must carry a valid access token.

application/json

403

The authenticated user lacks a required BAG_* permission on the collection (or a required system right). See code for the specific reason.

application/json

{
  "collection": {
    "_id": 1,
    "_id_parent": 1,
    "_version": 1,
    "children_allowed": true,
    "objects_allowed": true,
    "is_system_collection": true,
    "webfrontend_props": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "displayname": {
      "de-DE": "Deutscher text",
      "en-US": "English text"
    },
    "description": {
      "de-DE": "Deutscher text",
      "en-US": "English text"
    },
    "create_object": {
      "objecttype": "text",
      "mask_id": 1,
      "pool_id": 1,
      "linked_pool_id": 1,
      "pool": {
        "_basetype": "pool",
        "pool": {
          "_version": 1,
          "lookup:_id_parent": {
            "reference": "system:root"
          },
          "reference": "testpool",
          "comment": "horst",
          "name": {
            "de-DE": "Testpool [DE]",
            "en-US": "Testpool [EN]"
          }
        }
      },
      "linked_pool": {
        "_basetype": "pool",
        "pool": {
          "_version": 1,
          "lookup:_id_parent": {
            "reference": "system:root"
          },
          "reference": "testpool",
          "comment": "horst",
          "name": {
            "de-DE": "Testpool [DE]",
            "en-US": "Testpool [EN]"
          }
        }
      },
      "eas_field": "text",
      "linked_object_pools": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "hierarchy_linked_object": {
        "field": "text"
      },
      "mapping": "standard",
      "mapping_recipe_configs": {
        "ANY_ADDITIONAL_PROPERTY": {
          "imageconverter:browserthumbs": {
            "params": {
              "size": 1200,
              "format": "webp",
              "resize_mode": "max"
            }
          },
          "imageconverter:preview_pool_watermark": {
            "params": {
              "size": 600,
              "format": "jpg"
            }
          }
        }
      },
      "recognize_series": false,
      "recognize_version": false,
      "update_search_field": "text",
      "update_mode": "insert",
      "update_policy": "create_version",
      "tags": [
        {
          "_id": 1,
          "displayname": {
            "de-DE": "Dogs"
          },
          "enabled": true,
          "displaytype": "detail",
          "sticky": true
        }
      ],
      "plugin": "text",
      "plugin_config": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    },
    "reference": "text",
    "shortname": "text",
    "type": "text",
    "pin_code": "text",
    "uuid": "text",
    "lookup:_id": {
      "reference": "text"
    },
    "lookup:_id_parent": {
      "reference": "text"
    }
  },
  "_basetype": "collection",
  "_count": 1,
  "_count_recursive": 1,
  "_create_object_compiled": {
    "objecttype": "text",
    "mask_id": 1,
    "pool_id": 1,
    "linked_pool_id": 1,
    "pool": {
      "_basetype": "pool",
      "pool": {
        "_version": 1,
        "lookup:_id_parent": {
          "reference": "system:root"
        },
        "reference": "testpool",
        "comment": "horst",
        "name": {
          "de-DE": "Testpool [DE]",
          "en-US": "Testpool [EN]"
        }
      }
    },
    "linked_pool": {
      "_basetype": "pool",
      "pool": {
        "_version": 1,
        "lookup:_id_parent": {
          "reference": "system:root"
        },
        "reference": "testpool",
        "comment": "horst",
        "name": {
          "de-DE": "Testpool [DE]",
          "en-US": "Testpool [EN]"
        }
      }
    },
    "eas_field": "text",
    "linked_object_pools": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "hierarchy_linked_object": {
      "field": "text"
    },
    "mapping": "standard",
    "mapping_recipe_configs": {
      "ANY_ADDITIONAL_PROPERTY": {
        "imageconverter:browserthumbs": {
          "params": {
            "size": 1200,
            "format": "webp",
            "resize_mode": "max"
          }
        },
        "imageconverter:preview_pool_watermark": {
          "params": {
            "size": 600,
            "format": "jpg"
          }
        }
      }
    },
    "recognize_series": false,
    "recognize_version": false,
    "update_search_field": "text",
    "update_mode": "insert",
    "update_policy": "create_version",
    "tags": [
      {
        "_id": 1,
        "displayname": {
          "de-DE": "Dogs"
        },
        "enabled": true,
        "displaytype": "detail",
        "sticky": true
      }
    ],
    "plugin": "text",
    "plugin_config": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "_generated_rights": {
    "create": {},
    "create_in_collection": {},
    "read": {},
    "write": {},
    "delete": {},
    "asset_upload": {},
    "asset_show": {},
    "asset_download": {},
    "mask": {},
    "link": {},
    "acl": {},
    "change_owner": {},
    "unlink": {},
    "bag_read": {},
    "bag_write": {},
    "bag_acl": {},
    "bag_delete": {},
    "bag_create": {},
    "owner": {}
  },
  "_has_acl": true,
  "_has_children": true,
  "_has_remote_objects": true,
  "_level": true,
  "_acl": [
    {
      "_id": 1,
      "who": {
        "_basetype": "user",
        "_owner": true,
        "_pool_contact": true,
        "user": {
          "_id": 1,
          "_version": 1,
          "type": "system",
          "_generated_displayname": "text",
          "login": "text",
          "frontend_language": "text"
        },
        "group": {
          "_id": 1,
          "_generated_displayname": "text"
        }
      },
      "sticky": true,
      "active": true,
      "_right_preset": 1,
      "when": {
        "from": "text",
        "to": "text"
      },
      "rights": {
        "ANY_ADDITIONAL_PROPERTY": {
          "_grantable": true,
          "allow_update_and_remove": true,
          "classes": [
            "text"
          ],
          "extensions": [
            "text"
          ],
          "versions": [
            "text"
          ],
          "limit": "text",
          "mask_ids": {
            "ANY_ADDITIONAL_PROPERTY": [
              "standard"
            ]
          },
          "column_ids": [
            1
          ],
          "objecttype_ids": [
            1
          ],
          "pool_ids": [
            1
          ]
        }
      },
      "tagfilter": {
        "any": [
          1
        ],
        "all": [
          1
        ],
        "not": [
          1
        ]
      },
      "send_email_notification": {
        "text": "text"
      }
    }
  ],
  "_private_acl": true,
  "_path": [
    {
      "_basetype": "collection",
      "collection": {
        "_id": 1,
        "_id_parent": 1,
        "_version": 1,
        "displayname": "text"
      }
    }
  ],
  "_invalid_acl": true,
  "_owner": {
    "_basetype": "user",
    "_owner": true,
    "_pool_contact": true,
    "user": {
      "_id": 1,
      "_version": 1,
      "type": "system",
      "_generated_displayname": "text",
      "login": "text",
      "frontend_language": "text"
    },
    "group": {
      "_id": 1,
      "_generated_displayname": "text"
    }
  },
  "objects": [
    {
      "_global_object_id": "text",
      "webfrontend_props": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "lookup:_global_object_id": {
        "_allow_defer": true,
        "_objecttype": "text",
        "_system_object_id": 1,
        "_uuid": "text",
        "additionalProperties": "text"
      }
    }
  ],
  "_hotfolder_upload_urls": [
    {
      "type": "webdav",
      "url": "text"
    }
  ],
  "_has_pin": true,
  "pin_ok": true,
  "_created_at": "text",
  "_updated_at": "text"
}

GET /collection/{collection_id} — Retrieve a collection.

Retrieve a collection.

get

• The user needs BAG_READ to retrieve a collection.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Path parameters

collection_idintegerRequired

The collection id of the collection to access.

Header parameters

x-fylr-authorizationstringOptional

The access token in form of Bearer <token>. You can also use authorization which does the same. authorization is looked at first.

authorizationstringOptional

The access token in form of Bearer <token>.

Responses

200

The response contains the collection.

application/json

_basetypestring · enumOptionalPossible values:

_countnumber · int64Read-onlyOptional

The number of objects in this collection.

_count_recursivenumber · int64Read-onlyOptional

The number of objects in this collection and and all descendant collections (recursive).

_has_aclbooleanRead-onlyOptional

Flag that indicates that this collection has an active _acl (even if inherited).

_has_childrenbooleanRead-onlyOptional

Flag that inidicates if this collection has children. This flag is indpendent of the actual permissions of the user for that collection. So, if the user cannot access the only sub collection of this collection, the _has_children flag will still be set.

_has_remote_objectsbooleanRead-onlyOptional

Flag that inidicates if this collection contains at least one foreign collection object.

_levelbooleanRead-onlyOptional

Starting with 1, _level states the depth of the collection in the collection tree. The top level from the user's perspective is 3. The 1st level is the root collection, the 2nd level the user's top level collection which is a system collection and automatically created to hold all the user's collections underneath.

_private_aclbooleanOptional

Flag which indicates a private ACL. With this setting ACL from the parent are ignored (except for the items which set sticky.

_invalid_aclbooleanRead-onlyOptional

Collection can share permissions to other users. The owner of the collection must carry the grantable permission for each object in the collection in order to share the collection. fylr determines for the whole collection if sharing is allowed or not. If it is not allowed, the collection will be put in _invalid_acl: true state which disables the ACL attached to the collection.

_has_pinbooleanRead-onlyOptional

This flag indicates that the collection has a pin code. The actual pin code is only visible to system.root users and users with the BAG_ACL.

pin_okbooleanRead-onlyOptional

Flag to indicate that the pin was entered correctly for the current user. system.root and all users with the BAG_ACL permission will always see pin_ok.

_created_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was created.

_updated_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was updated.

401

No authenticated user. The request must carry a valid access token.

application/json

403

The authenticated user lacks a required BAG_* permission on the collection (or a required system right). See code for the specific reason.

application/json

404

The collection addressed by the URL does not exist.

application/json

{
  "collection": {
    "_id": 1,
    "_id_parent": 1,
    "_version": 1,
    "children_allowed": true,
    "objects_allowed": true,
    "is_system_collection": true,
    "webfrontend_props": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "displayname": {
      "de-DE": "Deutscher text",
      "en-US": "English text"
    },
    "description": {
      "de-DE": "Deutscher text",
      "en-US": "English text"
    },
    "create_object": {
      "objecttype": "text",
      "mask_id": 1,
      "pool_id": 1,
      "linked_pool_id": 1,
      "pool": {
        "_basetype": "pool",
        "pool": {
          "_version": 1,
          "lookup:_id_parent": {
            "reference": "system:root"
          },
          "reference": "testpool",
          "comment": "horst",
          "name": {
            "de-DE": "Testpool [DE]",
            "en-US": "Testpool [EN]"
          }
        }
      },
      "linked_pool": {
        "_basetype": "pool",
        "pool": {
          "_version": 1,
          "lookup:_id_parent": {
            "reference": "system:root"
          },
          "reference": "testpool",
          "comment": "horst",
          "name": {
            "de-DE": "Testpool [DE]",
            "en-US": "Testpool [EN]"
          }
        }
      },
      "eas_field": "text",
      "linked_object_pools": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "hierarchy_linked_object": {
        "field": "text"
      },
      "mapping": "standard",
      "mapping_recipe_configs": {
        "ANY_ADDITIONAL_PROPERTY": {
          "imageconverter:browserthumbs": {
            "params": {
              "size": 1200,
              "format": "webp",
              "resize_mode": "max"
            }
          },
          "imageconverter:preview_pool_watermark": {
            "params": {
              "size": 600,
              "format": "jpg"
            }
          }
        }
      },
      "recognize_series": false,
      "recognize_version": false,
      "update_search_field": "text",
      "update_mode": "insert",
      "update_policy": "create_version",
      "tags": [
        {
          "_id": 1,
          "displayname": {
            "de-DE": "Dogs"
          },
          "enabled": true,
          "displaytype": "detail",
          "sticky": true
        }
      ],
      "plugin": "text",
      "plugin_config": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    },
    "reference": "text",
    "shortname": "text",
    "type": "text",
    "pin_code": "text",
    "uuid": "text",
    "lookup:_id": {
      "reference": "text"
    },
    "lookup:_id_parent": {
      "reference": "text"
    }
  },
  "_basetype": "collection",
  "_count": 1,
  "_count_recursive": 1,
  "_create_object_compiled": {
    "objecttype": "text",
    "mask_id": 1,
    "pool_id": 1,
    "linked_pool_id": 1,
    "pool": {
      "_basetype": "pool",
      "pool": {
        "_version": 1,
        "lookup:_id_parent": {
          "reference": "system:root"
        },
        "reference": "testpool",
        "comment": "horst",
        "name": {
          "de-DE": "Testpool [DE]",
          "en-US": "Testpool [EN]"
        }
      }
    },
    "linked_pool": {
      "_basetype": "pool",
      "pool": {
        "_version": 1,
        "lookup:_id_parent": {
          "reference": "system:root"
        },
        "reference": "testpool",
        "comment": "horst",
        "name": {
          "de-DE": "Testpool [DE]",
          "en-US": "Testpool [EN]"
        }
      }
    },
    "eas_field": "text",
    "linked_object_pools": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "hierarchy_linked_object": {
      "field": "text"
    },
    "mapping": "standard",
    "mapping_recipe_configs": {
      "ANY_ADDITIONAL_PROPERTY": {
        "imageconverter:browserthumbs": {
          "params": {
            "size": 1200,
            "format": "webp",
            "resize_mode": "max"
          }
        },
        "imageconverter:preview_pool_watermark": {
          "params": {
            "size": 600,
            "format": "jpg"
          }
        }
      }
    },
    "recognize_series": false,
    "recognize_version": false,
    "update_search_field": "text",
    "update_mode": "insert",
    "update_policy": "create_version",
    "tags": [
      {
        "_id": 1,
        "displayname": {
          "de-DE": "Dogs"
        },
        "enabled": true,
        "displaytype": "detail",
        "sticky": true
      }
    ],
    "plugin": "text",
    "plugin_config": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "_generated_rights": {
    "create": {},
    "create_in_collection": {},
    "read": {},
    "write": {},
    "delete": {},
    "asset_upload": {},
    "asset_show": {},
    "asset_download": {},
    "mask": {},
    "link": {},
    "acl": {},
    "change_owner": {},
    "unlink": {},
    "bag_read": {},
    "bag_write": {},
    "bag_acl": {},
    "bag_delete": {},
    "bag_create": {},
    "owner": {}
  },
  "_has_acl": true,
  "_has_children": true,
  "_has_remote_objects": true,
  "_level": true,
  "_acl": [
    {
      "_id": 1,
      "who": {
        "_basetype": "user",
        "_owner": true,
        "_pool_contact": true,
        "user": {
          "_id": 1,
          "_version": 1,
          "type": "system",
          "_generated_displayname": "text",
          "login": "text",
          "frontend_language": "text"
        },
        "group": {
          "_id": 1,
          "_generated_displayname": "text"
        }
      },
      "sticky": true,
      "active": true,
      "_right_preset": 1,
      "when": {
        "from": "text",
        "to": "text"
      },
      "rights": {
        "ANY_ADDITIONAL_PROPERTY": {
          "_grantable": true,
          "allow_update_and_remove": true,
          "classes": [
            "text"
          ],
          "extensions": [
            "text"
          ],
          "versions": [
            "text"
          ],
          "limit": "text",
          "mask_ids": {
            "ANY_ADDITIONAL_PROPERTY": [
              "standard"
            ]
          },
          "column_ids": [
            1
          ],
          "objecttype_ids": [
            1
          ],
          "pool_ids": [
            1
          ]
        }
      },
      "tagfilter": {
        "any": [
          1
        ],
        "all": [
          1
        ],
        "not": [
          1
        ]
      },
      "send_email_notification": {
        "text": "text"
      }
    }
  ],
  "_private_acl": true,
  "_path": [
    {
      "_basetype": "collection",
      "collection": {
        "_id": 1,
        "_id_parent": 1,
        "_version": 1,
        "displayname": "text"
      }
    }
  ],
  "_invalid_acl": true,
  "_owner": {
    "_basetype": "user",
    "_owner": true,
    "_pool_contact": true,
    "user": {
      "_id": 1,
      "_version": 1,
      "type": "system",
      "_generated_displayname": "text",
      "login": "text",
      "frontend_language": "text"
    },
    "group": {
      "_id": 1,
      "_generated_displayname": "text"
    }
  },
  "objects": [
    {
      "_global_object_id": "text",
      "webfrontend_props": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "lookup:_global_object_id": {
        "_allow_defer": true,
        "_objecttype": "text",
        "_system_object_id": 1,
        "_uuid": "text",
        "additionalProperties": "text"
      }
    }
  ],
  "_hotfolder_upload_urls": [
    {
      "type": "webdav",
      "url": "text"
    }
  ],
  "_has_pin": true,
  "pin_ok": true,
  "_created_at": "text",
  "_updated_at": "text"
}

POST /collection/{collection_id} — Update collection.

Update collection.

post

• The user needs BAG_WRITE to update a collection.
• Moving a collection to a new parent requires BAG_CREATE in the new parent and BAG_ACL in the current collection. When moving a collection, the owner is automatically set to the owner of the parent. This includes all child collections.
• New ACL items with send_email_notification will sent out and email.
• To set _private_acl or _aclthe user needs BAG_ACL.
• COLLECTION_UPDATE event is written.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Path parameters

collection_idintegerRequired

The collection id of the collection to access.

Query parameters

allow_invalid_aclstring · booleanOptional

Allow storing the collection even if the owner doesn't have the necessary permissions for all objects to share the rights defined in the _acl property of the collection. The _invalid_acl flag will be set, if the user doesn't have sufficient permissions to share all objects of the collection. The user needs the permission BAG_ACL for the collection in order to use this parameter.

Differs from easydb 5: this confirmation is driven by the boolean allow_invalid_acl parameter. easydb 5 instead resolves the 202 confirmation with a collection_rights_policy query parameter; there is no allow_invalid_acl parameter in easydb 5.

background_invalid_aclstring · booleanOptional

If set, the invalid-ACL validity check (whether the collection owner may grant the rights of all linked objects) is not run inline. Instead a queued ACTION_COLLECTION_ACL_CHECK job is scheduled and the request returns immediately, before the check has resolved.

Header parameters

x-fylr-authorizationstringOptional

The access token in form of Bearer <token>. You can also use authorization which does the same. authorization is looked at first.

authorizationstringOptional

The access token in form of Bearer <token>.

Body

application/json

_basetypestring · enumOptionalPossible values:

_countnumber · int64Read-onlyOptional

The number of objects in this collection.

_count_recursivenumber · int64Read-onlyOptional

The number of objects in this collection and and all descendant collections (recursive).

_has_aclbooleanRead-onlyOptional

Flag that indicates that this collection has an active _acl (even if inherited).

_has_childrenbooleanRead-onlyOptional

Flag that inidicates if this collection has children. This flag is indpendent of the actual permissions of the user for that collection. So, if the user cannot access the only sub collection of this collection, the _has_children flag will still be set.

_has_remote_objectsbooleanRead-onlyOptional

Flag that inidicates if this collection contains at least one foreign collection object.

_levelbooleanRead-onlyOptional

Starting with 1, _level states the depth of the collection in the collection tree. The top level from the user's perspective is 3. The 1st level is the root collection, the 2nd level the user's top level collection which is a system collection and automatically created to hold all the user's collections underneath.

_private_aclbooleanOptional

Flag which indicates a private ACL. With this setting ACL from the parent are ignored (except for the items which set sticky.

_invalid_aclbooleanRead-onlyOptional

Collection can share permissions to other users. The owner of the collection must carry the grantable permission for each object in the collection in order to share the collection. fylr determines for the whole collection if sharing is allowed or not. If it is not allowed, the collection will be put in _invalid_acl: true state which disables the ACL attached to the collection.

_has_pinbooleanRead-onlyOptional

This flag indicates that the collection has a pin code. The actual pin code is only visible to system.root users and users with the BAG_ACL.

pin_okbooleanRead-onlyOptional

Flag to indicate that the pin was entered correctly for the current user. system.root and all users with the BAG_ACL permission will always see pin_ok.

_created_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was created.

_updated_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was updated.

Responses

200

The response contains the collection created, including the issued _id.

application/json

_basetypestring · enumOptionalPossible values:

_countnumber · int64Read-onlyOptional

The number of objects in this collection.

_count_recursivenumber · int64Read-onlyOptional

The number of objects in this collection and and all descendant collections (recursive).

_has_aclbooleanRead-onlyOptional

Flag that indicates that this collection has an active _acl (even if inherited).

_has_childrenbooleanRead-onlyOptional

Flag that inidicates if this collection has children. This flag is indpendent of the actual permissions of the user for that collection. So, if the user cannot access the only sub collection of this collection, the _has_children flag will still be set.

_has_remote_objectsbooleanRead-onlyOptional

Flag that inidicates if this collection contains at least one foreign collection object.

_levelbooleanRead-onlyOptional

Starting with 1, _level states the depth of the collection in the collection tree. The top level from the user's perspective is 3. The 1st level is the root collection, the 2nd level the user's top level collection which is a system collection and automatically created to hold all the user's collections underneath.

_private_aclbooleanOptional

Flag which indicates a private ACL. With this setting ACL from the parent are ignored (except for the items which set sticky.

_invalid_aclbooleanRead-onlyOptional

Collection can share permissions to other users. The owner of the collection must carry the grantable permission for each object in the collection in order to share the collection. fylr determines for the whole collection if sharing is allowed or not. If it is not allowed, the collection will be put in _invalid_acl: true state which disables the ACL attached to the collection.

_has_pinbooleanRead-onlyOptional

This flag indicates that the collection has a pin code. The actual pin code is only visible to system.root users and users with the BAG_ACL.

pin_okbooleanRead-onlyOptional

Flag to indicate that the pin was entered correctly for the current user. system.root and all users with the BAG_ACL permission will always see pin_ok.

_created_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was created.

_updated_atstring · RFC3339_dateRead-onlyOptional

Timestamp when this collection was updated.

202

The collection owner lacks a grantable right for a linked object and the caller has BAG_ACL. Re-send with allow_invalid_acl=true to store the collection with sharing disabled.

application/json

400

The request could not be processed. The code field of the response identifies which validation rejected the request.

application/json

401

No authenticated user. The request must carry a valid access token.

application/json

403

The authenticated user lacks a required BAG_* permission on the collection (or a required system right). See code for the specific reason.

application/json

404

The collection addressed by the URL does not exist.

application/json

{
  "collection": {
    "_id": 1,
    "_id_parent": 1,
    "_version": 1,
    "children_allowed": true,
    "objects_allowed": true,
    "is_system_collection": true,
    "webfrontend_props": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "displayname": {
      "de-DE": "Deutscher text",
      "en-US": "English text"
    },
    "description": {
      "de-DE": "Deutscher text",
      "en-US": "English text"
    },
    "create_object": {
      "objecttype": "text",
      "mask_id": 1,
      "pool_id": 1,
      "linked_pool_id": 1,
      "pool": {
        "_basetype": "pool",
        "pool": {
          "_version": 1,
          "lookup:_id_parent": {
            "reference": "system:root"
          },
          "reference": "testpool",
          "comment": "horst",
          "name": {
            "de-DE": "Testpool [DE]",
            "en-US": "Testpool [EN]"
          }
        }
      },
      "linked_pool": {
        "_basetype": "pool",
        "pool": {
          "_version": 1,
          "lookup:_id_parent": {
            "reference": "system:root"
          },
          "reference": "testpool",
          "comment": "horst",
          "name": {
            "de-DE": "Testpool [DE]",
            "en-US": "Testpool [EN]"
          }
        }
      },
      "eas_field": "text",
      "linked_object_pools": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "hierarchy_linked_object": {
        "field": "text"
      },
      "mapping": "standard",
      "mapping_recipe_configs": {
        "ANY_ADDITIONAL_PROPERTY": {
          "imageconverter:browserthumbs": {
            "params": {
              "size": 1200,
              "format": "webp",
              "resize_mode": "max"
            }
          },
          "imageconverter:preview_pool_watermark": {
            "params": {
              "size": 600,
              "format": "jpg"
            }
          }
        }
      },
      "recognize_series": false,
      "recognize_version": false,
      "update_search_field": "text",
      "update_mode": "insert",
      "update_policy": "create_version",
      "tags": [
        {
          "_id": 1,
          "displayname": {
            "de-DE": "Dogs"
          },
          "enabled": true,
          "displaytype": "detail",
          "sticky": true
        }
      ],
      "plugin": "text",
      "plugin_config": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    },
    "reference": "text",
    "shortname": "text",
    "type": "text",
    "pin_code": "text",
    "uuid": "text",
    "lookup:_id": {
      "reference": "text"
    },
    "lookup:_id_parent": {
      "reference": "text"
    }
  },
  "_basetype": "collection",
  "_count": 1,
  "_count_recursive": 1,
  "_create_object_compiled": {
    "objecttype": "text",
    "mask_id": 1,
    "pool_id": 1,
    "linked_pool_id": 1,
    "pool": {
      "_basetype": "pool",
      "pool": {
        "_version": 1,
        "lookup:_id_parent": {
          "reference": "system:root"
        },
        "reference": "testpool",
        "comment": "horst",
        "name": {
          "de-DE": "Testpool [DE]",
          "en-US": "Testpool [EN]"
        }
      }
    },
    "linked_pool": {
      "_basetype": "pool",
      "pool": {
        "_version": 1,
        "lookup:_id_parent": {
          "reference": "system:root"
        },
        "reference": "testpool",
        "comment": "horst",
        "name": {
          "de-DE": "Testpool [DE]",
          "en-US": "Testpool [EN]"
        }
      }
    },
    "eas_field": "text",
    "linked_object_pools": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "hierarchy_linked_object": {
      "field": "text"
    },
    "mapping": "standard",
    "mapping_recipe_configs": {
      "ANY_ADDITIONAL_PROPERTY": {
        "imageconverter:browserthumbs": {
          "params": {
            "size": 1200,
            "format": "webp",
            "resize_mode": "max"
          }
        },
        "imageconverter:preview_pool_watermark": {
          "params": {
            "size": 600,
            "format": "jpg"
          }
        }
      }
    },
    "recognize_series": false,
    "recognize_version": false,
    "update_search_field": "text",
    "update_mode": "insert",
    "update_policy": "create_version",
    "tags": [
      {
        "_id": 1,
        "displayname": {
          "de-DE": "Dogs"
        },
        "enabled": true,
        "displaytype": "detail",
        "sticky": true
      }
    ],
    "plugin": "text",
    "plugin_config": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  },
  "_generated_rights": {
    "create": {},
    "create_in_collection": {},
    "read": {},
    "write": {},
    "delete": {},
    "asset_upload": {},
    "asset_show": {},
    "asset_download": {},
    "mask": {},
    "link": {},
    "acl": {},
    "change_owner": {},
    "unlink": {},
    "bag_read": {},
    "bag_write": {},
    "bag_acl": {},
    "bag_delete": {},
    "bag_create": {},
    "owner": {}
  },
  "_has_acl": true,
  "_has_children": true,
  "_has_remote_objects": true,
  "_level": true,
  "_acl": [
    {
      "_id": 1,
      "who": {
        "_basetype": "user",
        "_owner": true,
        "_pool_contact": true,
        "user": {
          "_id": 1,
          "_version": 1,
          "type": "system",
          "_generated_displayname": "text",
          "login": "text",
          "frontend_language": "text"
        },
        "group": {
          "_id": 1,
          "_generated_displayname": "text"
        }
      },
      "sticky": true,
      "active": true,
      "_right_preset": 1,
      "when": {
        "from": "text",
        "to": "text"
      },
      "rights": {
        "ANY_ADDITIONAL_PROPERTY": {
          "_grantable": true,
          "allow_update_and_remove": true,
          "classes": [
            "text"
          ],
          "extensions": [
            "text"
          ],
          "versions": [
            "text"
          ],
          "limit": "text",
          "mask_ids": {
            "ANY_ADDITIONAL_PROPERTY": [
              "standard"
            ]
          },
          "column_ids": [
            1
          ],
          "objecttype_ids": [
            1
          ],
          "pool_ids": [
            1
          ]
        }
      },
      "tagfilter": {
        "any": [
          1
        ],
        "all": [
          1
        ],
        "not": [
          1
        ]
      },
      "send_email_notification": {
        "text": "text"
      }
    }
  ],
  "_private_acl": true,
  "_path": [
    {
      "_basetype": "collection",
      "collection": {
        "_id": 1,
        "_id_parent": 1,
        "_version": 1,
        "displayname": "text"
      }
    }
  ],
  "_invalid_acl": true,
  "_owner": {
    "_basetype": "user",
    "_owner": true,
    "_pool_contact": true,
    "user": {
      "_id": 1,
      "_version": 1,
      "type": "system",
      "_generated_displayname": "text",
      "login": "text",
      "frontend_language": "text"
    },
    "group": {
      "_id": 1,
      "_generated_displayname": "text"
    }
  },
  "objects": [
    {
      "_global_object_id": "text",
      "webfrontend_props": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "lookup:_global_object_id": {
        "_allow_defer": true,
        "_objecttype": "text",
        "_system_object_id": 1,
        "_uuid": "text",
        "additionalProperties": "text"
      }
    }
  ],
  "_hotfolder_upload_urls": [
    {
      "type": "webdav",
      "url": "text"
    }
  ],
  "_has_pin": true,
  "pin_ok": true,
  "_created_at": "text",
  "_updated_at": "text"
}

DELETE /collection/{collection_id} — Delete collection. All child collections will be deleted too.

Delete collection. All child collections will be deleted too.

delete

• The user needs BAG_DELETE for each collection to be deleted.
• COLLECTION_DELETE event is written for each collection.

Authorizations

BearerAuthAccessTokenQueryFylrAuthHeader

AuthorizationstringRequired

Access token in the Authorization header: Authorization: Bearer <token>.

Path parameters

collection_idintegerRequired

The collection id of the collection to access.

Header parameters

x-fylr-authorizationstringOptional

The access token in form of Bearer <token>. You can also use authorization which does the same. authorization is looked at first.

authorizationstringOptional

The access token in form of Bearer <token>.

Responses

200

Delete was successful.

application/json

401

No authenticated user. The request must carry a valid access token.

application/json

403

The authenticated user lacks a required BAG_* permission on the collection (or a required system right). See code for the specific reason.

application/json

404

The collection addressed by the URL does not exist.

application/json

{
  "status": {
    "acknowledged": "ok"
  }
}