{ "opencollection": "1.0.0", "info": { "name": "Skilljar Assets Domains API", "version": "1.0.0" }, "items": [ { "info": { "name": "Domains", "type": "folder" }, "items": [ { "info": { "name": "domains_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/domains", "params": [ { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List all domains.\n\nReturns a paginated list of domains for your organization,\n including their names, access settings, and catalog titles." }, { "info": { "name": "domains_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/domains/:domain_name", "params": [ { "name": "domain_name", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve a domain.\n\nReturns details for a specific domain,\n including its name, catalog title, access settings, and marketing messages." }, { "info": { "name": "domains_update", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/v1/domains/:domain_name", "params": [ { "name": "domain_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Update a domain.\n\nAllows updating one or more fields of a domain. Both PUT and PATCH requests perform partial updates." }, { "info": { "name": "domains_partial_update", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/v1/domains/:domain_name", "params": [ { "name": "domain_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Partially update a domain.\n\nAllows updating specific fields of a domain." }, { "info": { "name": "domains_catalog_pages_visibility_overrides_list", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/domains/:domain_name/catalog-pages/:catalog_page_id/visibility-overrides", "params": [ { "name": "catalog_page_id", "value": "", "type": "path" }, { "name": "domain_name", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query", "description": "A page number within the paginated result set." }, { "name": "page_size", "value": "", "type": "query", "description": "Number of results to return per page." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List Student Group visibility overrides for a given Catalog Page." }, { "info": { "name": "domains_catalog_pages_visibility_overrides_create", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/v1/domains/:domain_name/catalog-pages/:catalog_page_id/visibility-overrides", "params": [ { "name": "catalog_page_id", "value": "", "type": "path" }, { "name": "domain_name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a Student Group visibility override for a Catalog Page." }, { "info": { "name": "domains_catalog_pages_visibility_overrides_retrieve", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/v1/domains/:domain_name/catalog-pages/:catalog_page_id/visibility-overrides/:student_group_id", "params": [ { "name": "catalog_page_id", "value": "", "type": "path" }, { "name": "domain_name", "value": "", "type": "path" }, { "name": "student_group_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Retrieve Student Group visibility override for Catalog Page.\n\nReturns Student Group information and visibility status." }, { "info": { "name": "domains_catalog_pages_visibility_overrides_destroy", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/v1/domains/:domain_name/catalog-pages/:catalog_page_id/visibility-overrides/:student_group_id", "params": [ { "name": "catalog_page_id", "value": "", "type": "path" }, { "name": "domain_name", "value": "", "type": "path" }, { "name": "student_group_id", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Deletes a Student Group visibility override for a Catalog Page and returns a `204` response." } ] } ], "bundled": true }