logo
logo

Domain management

The Sitecore Content Hub™, domain model contains a library of specifications and mappings.

Access the OpenAPI

To access the OpenAPI:

  1. On the menu bar, click Manage .

  2. On the Manage page, click OpenAPI.

    The OpenAPI page lists existing domains.

    On the OpenAPI page, you can do the following:

Create a domain

To create a domain:

  1. On the OpenAPI page, click + Domain.
  2. In the Domain dialog box, enter the following information:

    FieldTypeValueMandatory/optional
    NameStringName of the new domainMandatory
    EnabledToggle switchEnabled/disabledOptional
    DescriptionStringDescription of the new domainOptional
    IdentifierStringIdentifier of the new domainMandatory
  3. Click Save.

Configure a new domain

To configure a new domain:

  1. On the OpenAPI page, for the new domain, click View details .

  2. On the domain details page, click Edit .

  3. In the Specification section, enter the required data mappings, such as parameters, responses, and data models.

    Note

    To see an example of a Content Hub domain definition, see Domain specification template.

  4. Select the required value from the Status drop-down list.

    Available options are:

    StatusDescription
    DraftThe default status
    ActiveThe specification cannot be edited
    DisabledThe specification cannot be retrieved via the API
  5. Click Save.

Edit an existing domain

To edit an existing domain:

  1. On the OpenAPI page, next the domain to edit, click View Details .

  2. On the domain details page, click Edit .

  3. Make the required changes and click Save.

Delete a domain

To delete a domain:

  1. On the OpenAPI page, next to the domain to delete, click Delete :

  2. In the Delete dialog box, click Ok to confirm the deletion.

Enable or disable a domain

To enable or disable a domain:

  • On the OpenAPI page, next to the domain that you want to enable or disable, turn the switch to On (enable) or Off (disable).

Can we improve this article ? Provide feedback