{
  "opencollection": "1.0.0",
  "info": {
    "name": "Skilljar Assets Domains > Published Paths API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Domains > Published Paths",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "domains_published_paths_list",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/domains/:domain_name/published-paths",
            "params": [
              {
                "name": "domain_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "include_searchable_content",
                "value": "",
                "type": "query",
                "description": "If set to True, the response also includes the following fields ('path_item_list', 'title', 'short_description', 'long_description_html', 'search_keywords' 'tags', 'hidden')"
              },
              {
                "name": "label__name",
                "value": "",
                "type": "query",
                "description": "Filters published paths by exact match on label name"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "A page number within the paginated result set."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "URL encoded string, return the results and the order as if a catalog search. Note - This does not search within the path_item_list."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "List all Published Paths for the specified domain.\n\nReturns a paginated list of Published Paths available on the domain. Supports filtering and search."
        },
        {
          "info": {
            "name": "domains_published_paths_create",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/v1/domains/:domain_name/published-paths",
            "params": [
              {
                "name": "domain_name",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Create a new Published Path and its associated Path object.\n\nThe created Published Path will have a default Offer attached.\nRequired and optional fields for the Path object are documented in the schema."
        },
        {
          "info": {
            "name": "domains_published_paths_retrieve",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/v1/domains/:domain_name/published-paths/:published_path_id",
            "params": [
              {
                "name": "domain_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "published_path_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieve details for a specific Published Path.\n\nReturns all metadata and configuration for the Published Path, including associated offers and path details."
        },
        {
          "info": {
            "name": "domains_published_paths_update",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/v1/domains/:domain_name/published-paths/:published_path_id",
            "params": [
              {
                "name": "domain_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "published_path_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Update a Published Path.\n\nAllows partial updates to Published Path fields, such as the slug. Both PUT and PATCH perform partial updates."
        },
        {
          "info": {
            "name": "domains_published_paths_partial_update",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "{{baseUrl}}/v1/domains/:domain_name/published-paths/:published_path_id",
            "params": [
              {
                "name": "domain_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "published_path_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Partially update a Published Path.\n\nAllows updating one or more fields of the Published Path, such as the slug."
        },
        {
          "info": {
            "name": "domains_published_paths_destroy",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "{{baseUrl}}/v1/domains/:domain_name/published-paths/:published_path_id",
            "params": [
              {
                "name": "domain_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "published_path_id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a Published Path.\n\nRemoves the Published Path and its associated course series from the domain."
        }
      ]
    }
  ],
  "bundled": true
}