{ "opencollection": "1.0.0", "info": { "name": "UserDefinedMetadata API", "version": "1.0" }, "items": [ { "info": { "name": "UserDefinedMetadata", "type": "folder" }, "items": [ { "info": { "name": "List User-Defined Metadata Fields", "type": "http" }, "http": { "method": "GET", "url": "/api/knowledge/v1alpha1/collections/:collection_id/user-defined-metadata-fields", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "Unique identifier for the parent collection; autogenerated and not editable." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum page size is 100; default is 100." }, { "name": "page_token", "value": "", "type": "query", "description": "For multiple pages; must be specified in each request for two pages per sheet." } ] }, "docs": "List user-defined metadata fields." }, { "info": { "name": "Get User-Defined Metadata Fields", "type": "http" }, "http": { "method": "GET", "url": "/api/knowledge/v1alpha1/collections/:collection_id/user-defined-metadata-fields/:user_defined_metadata_field_id", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "Unique identifier for the parent collection; autogenerated and not editable." }, { "name": "user_defined_metadata_field_id", "value": "", "type": "path", "description": "A unique indentifier for the collection-level metadata field." } ] }, "docs": "Get a user-defined metadata field." }, { "info": { "name": "Delete User-Defined Metadata Fields", "type": "http" }, "http": { "method": "DELETE", "url": "/api/knowledge/v1alpha1/collections/:collection_id/user-defined-metadata-fields/:user_defined_metadata_field_id", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "TUnique identifier for the parent collection; autogenerated and not editable." }, { "name": "user_defined_metadata_field_id", "value": "", "type": "path", "description": "A unique indentifier for the user-defined metadata field." } ] }, "docs": "Delete a user-defined metadata field." }, { "info": { "name": "List User-Defined Metadata Field Values", "type": "http" }, "http": { "method": "GET", "url": "/api/knowledge/v1alpha1/collections/:collection_id/user-defined-metadata-fields/:user_defined_metadata_field_id/values", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "Unique identifier for the parent collection; autogenerated and not editable." }, { "name": "user_defined_metadata_field_id", "value": "", "type": "path", "description": "The unique identifier for the user-defined metadata field." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum page size is 100; default is 100." }, { "name": "page_token", "value": "", "type": "query", "description": "For multiple pages; must be specified in each request for two pages per sheet." } ] }, "docs": "List user-defined metadata field values." }, { "info": { "name": "Get User-Defined Metadata Field Values", "type": "http" }, "http": { "method": "GET", "url": "/api/knowledge/v1alpha1/collections/:collection_id/user-defined-metadata-fields/:user_defined_metadata_field_id/values/:user_defined_metadata_field_value_id", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "Unique identifier for the parent collection; autogenerated and not editable." }, { "name": "user_defined_metadata_field_id", "value": "", "type": "path", "description": "The unique identifier for the user-defined metadata field." }, { "name": "user_defined_metadata_field_value_id", "value": "", "type": "path", "description": "The unique identifier for the user-defined metadata field value." } ] }, "docs": "Get a user-defined metadata field value." }, { "info": { "name": "Delete User-Defined Metadata Field Values", "type": "http" }, "http": { "method": "DELETE", "url": "/api/knowledge/v1alpha1/collections/:collection_id/user-defined-metadata-fields/:user_defined_metadata_field_id/values/:user_defined_metadata_field_value_id", "params": [ { "name": "collection_id", "value": "", "type": "path", "description": "Unique identifier for the parent collection; autogenerated and not editable." }, { "name": "user_defined_metadata_field_id", "value": "", "type": "path", "description": "The unique identifier for the user-defined metadata field." }, { "name": "user_defined_metadata_field_value_id", "value": "", "type": "path", "description": "The unique identifier for the user-defined metadata field value." } ] }, "docs": "Delete a user-defined metadata field value." }, { "info": { "name": "Create User-Defined Metadata Fields", "type": "http" }, "http": { "method": "POST", "url": "/api/knowledge/v1alpha1/collections/:data.collection_id/user-defined-metadata-fields", "params": [ { "name": "data.collection_id", "value": "", "type": "path", "description": "Unique identifier for the parent collection; autogenerated and not editable." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new user-defined metadata field for a collection." }, { "info": { "name": "Update User-Defined Metadata Fields", "type": "http" }, "http": { "method": "PATCH", "url": "/api/knowledge/v1alpha1/collections/:data.collection_id/user-defined-metadata-fields/:data.user_defined_metadata_field_id", "params": [ { "name": "data.collection_id", "value": "", "type": "path", "description": "Unique identifier for the parent collection; autogenerated and not editable." }, { "name": "data.user_defined_metadata_field_id", "value": "", "type": "path", "description": "The unique identifier for the metadata field." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a user-defined metadata field." }, { "info": { "name": "Create User-Defined Metadata Field Values", "type": "http" }, "http": { "method": "POST", "url": "/api/knowledge/v1alpha1/collections/:data.collection_id/user-defined-metadata-fields/:data.user_defined_metadata_field_id/values", "params": [ { "name": "data.collection_id", "value": "", "type": "path", "description": "Unique identifier for the parent collection; autogenerated and not editable." }, { "name": "data.user_defined_metadata_field_id", "value": "", "type": "path", "description": "The unique identifier for the metadata field." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new user-defined metadata field value." }, { "info": { "name": "Update User-Defined Metadata Field Values", "type": "http" }, "http": { "method": "PATCH", "url": "/api/knowledge/v1alpha1/collections/:data.collection_id/user-defined-metadata-fields/:data.user_defined_metadata_field_id/values/:data.user_defined_metadata_field_value_id", "params": [ { "name": "data.collection_id", "value": "", "type": "path", "description": "Unique identifier for the parent collection; autogenerated and not editable." }, { "name": "data.user_defined_metadata_field_id", "value": "", "type": "path", "description": "The unique identifier for the metadata field." }, { "name": "data.user_defined_metadata_field_value_id", "value": "", "type": "path", "description": "The unique identifier for the metadata field value." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a user-defined metadata field value." }, { "info": { "name": "List Org IDs using Metadata Field", "type": "http" }, "http": { "method": "GET", "url": "/api/knowledge/v1alpha1/metadata-fields/:metadata_field_id/collections", "params": [ { "name": "metadata_field_id", "value": "", "type": "path", "description": "The ID of the org-level user-defined metadata field." }, { "name": "page_size", "value": "", "type": "query", "description": "Maximum page size is 100; default is 100." }, { "name": "page_token", "value": "", "type": "query", "description": "For multiple pages; must be specified in each request for two pages per sheet." } ] }, "docs": "List collection IDs by org-level user-defined metadata field ID." } ] } ], "bundled": true }