### ContentPrototypeProperties Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

An example of the ContentPrototypeProperties object, illustrating its structure and common properties.

```json
{
  "workflow-control": {
    "option": {
      "name": "Camille Marshal",
      "enabled": true
    }
  },
  "link": {
    "rel": "some text",
    "href": "some text",
    "type": "some text",
    "lang": "en",
    "label": "some text"
  },
  "createNewParent": true,
  "placement": "FIRST_CHILD",
  "location_options": {}
}
```

--------------------------------

### RenderContent Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

An example of the RenderContent object, which includes an ID, context site area ID, and HTML markup.

```json
{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "contextSiteAreaID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "markup": "<div role=\"main\" class=\"lotusui lotusui30\"> 
<div class=\"lotusWelcomeBox\">
   <h2>Sample Article</h2>

   <div class=\"lotusBtnContainer\"><span class=\"lotusBtn\"><a title=\"New\" aria-haspopup=\"true\" href=\"/wps/myportal/wcmAuthoring?pid=com.aptrix.pluto.site.SiteArea/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&amp;atid=com.aptrix.pluto.presentation.Template/0105b76e-c99e-4a51-afb4-3ec9ef286a7c&amp;directType=com.aptrix.pluto.content.Content&amp;wcmAuthoringAction=new\">New</a></span><span class=\"lotusBtn\"><a title=\"Edit\" aria-haspopup=\"true\" href=\"/wps/myportal/wcmAuthoring?wcmAuthoringAction=edit&amp;docid=com.aptrix.pluto.content.Content/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\">Edit</a></span><!-- Uncomment to add delete action to toolbar <span class=\"lotusBtn\"><a title=\"Delete\" aria-haspopup=\"true\" href=\"/wps/myportal/wcmAuthoring?wcmAuthoringAction=delete&amp;docid=com.aptrix.pluto.content.Content/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\">Delete</a></span>--></div>
<br/>

   <p style=\"margin: 0px;\">
	This is a content item named \"Sample Article\". The text displayed on this page is being referenced from a rich text element named \"Body\" that is stored in this content item. To edit this content item, click <strong>Edit</strong>.</p>
<p style=\"margin: 0px;\">
	&nbsp;</p>
<p style=\"margin: 0px;\">
	To create a new content item, click <strong>New</strong>. Once saved, the new content item will be listed in the menu component displayed below this content item.  You can edit this menu component by accessing the authoring portlet located under <strong>Applications &gt; Content &gt; Web Content Management</strong> and editing the menu component named \"Articles List\".</p>
<p style=\"margin: 0px;\">
	&nbsp;</p>
<p style=\"margin: 0px;\">
	For further information on using Web Content Management and these default Web content items, go to the HCL Digital Experience Help Center: http://www-10.lotus.com/ldd/portalwiki.nsf</p>


   
</div> <!-- end welcomeBox -->

<table role=\"presentation\" class=\"lotusTable\" border=\"0\" cellspacing=\"0\" cellpadding=\"0\" summary=\"\"><tbody>
<tr>					
      <td><h4><a href=\"/wps/mycontenthandler/web+content/articles/sample+article+2\">Sample Article 2</a></h4><div class=\"lotusMeta\">31 Jan 2024</div></td>
</tr></tbody></table>

</div>
```

--------------------------------

### Update Authors Users Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

This example shows the format for specifying users to be added or removed, using their distinguished names (dn).

```json
"users": ["uid=editor,o=defaultWIMFileBasedRealm", "uid=someuser,o=defaultWIMFileBasedRealm"]
```

--------------------------------

### Authoring Tools Component Request Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

Example of a request body for an AuthoringTools Component, including title, logo, description, and links.

```json
{
  "entry": {
    "title": {
      "lang": "en",
      "value": "AuthoringTools Component Title"
    },
    "x-logo": {
      "url": "../DX_logo.svg",
      "backgroundColor": "#F2F4F5",
      "altText": "HCL_Digital_Experience"
    },
    "description": {
      "lang": "en",
      "value": "AuthoringTools Component Description"
    },
    "name": "AuthoringTools Component Name",
    "type": "LibraryAuthoringToolsComponent",
    "link": [
      {
        "rel": "library",
        "href": "/wps/mycontenthandler/!ut/p/digest!twPMi6jVozoaYJpgXlU2uA/wcmrest-v2/libraries/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "lang": "en",
        "label": "Library"
      }
    ]
  }
}
```

--------------------------------

### JSPComponentEntry Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

An example of a JSP Component entry, including metadata like title, description, name, type, links, and content details.

```json
{
  "title": {
    "lang": "en",
    "value": "SampleJSP"
  },
  "x-logo": {
    "url": "../DX_logo.svg",
    "backgroundColor": "#F2F4F5",
    "altText": "HCL_Digital_Experience"
  },
  "description": {
    "lang": "en",
    "value": "SampleJSP"
  },
  "name": "SampleJSP",
  "type": "LibraryJSPComponent",
  "link": [
    {
      "rel": "library",
      "href": "/wps/mycontenthandler/!ut/p/digest!ZQIc3myUiWrtisw3ZfAjkg/wcmrest-v2/libraries/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "lang": "en",
      "label": "Library"
    }
  ],
  "content": {
    "type": "application/vnd.ibm.wcm+xml",
    "jsp": {
      "path": "/samplepath",
      "errorMessage": "sample error"
    }
  }
}
```

--------------------------------

### RenderContentSchema Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

A basic example of the RenderContentSchema object, used for defining content structure with ID, context site area ID, and markup.

```json
{
  "id": "some text",
  "contextSiteAreaID": "some text",
  "markup": "some mark up value"
}
```

--------------------------------

### OperationsCollection Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

This JSON object illustrates the structure of an OperationsCollection, showing details for multiple operations including their success and failure counts, start and stop times, and creator information.

```json
{
  "total": "4",
  "overall": "4",
  "data": [
    {
      "pollingId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "totalNumBulkItems": "1",
      "numBulkItemsProcessed": "1",
      "startTime": "Wed May 17 19:29:10 UTC 2023",
      "stopTime": "Wed May 17 19:29:10 UTC 2023",
      "numItemsSuccess": "1",
      "numItemsFail": "0",
      "status": "COMPLETE",
      "action": "some action",
      "criteria": "some criteria",
      "creator": {
        "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
        "uri": "/wps/mycontenthandler/!ut/p/digest!mBVmxcmpiAZ_U6GQaRauzw/um/users/profiles/Z9eAePPC8MQ866BO4JM476BCGJMG6OHOIJM8C6BD4JM06K9PA6S46IPDI3OCCI1",
        "name": "wpsadmin",
        "type": "USER"
      },
      "aggregateResults": [
        {
          "statusCode": "OK",
          "title": "some text",
          "type": "object type",
          "createdBy": "wpsadmin",
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "link": "/wps/mycontenthandler/!ut/p/digest!mBVmxcmpiAZ_U6GQaRauzw/wcmrest/SiteArea/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?mime-type=application%2Fjson"
        }
      ]
    },
    {
      "pollingId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "totalNumBulkItems": "2",
      "numBulkItemsProcessed": "2",
      "startTime": "Wed May 17 19:28:58 UTC 2023",
      "stopTime": "Wed May 17 19:28:58 UTC 2023",
      "numItemsSuccess": "0",
      "numItemsFail": "2",
      "status": "COMPLETE",
      "action": "updateExpiry",
      "creator": {
        "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
        "uri": "/wps/mycontenthandler/!ut/p/digest!mBVmxcmpiAZ_U6GQaRauzw/um/users/profiles/Z9eAePPC8MQ866BO4JM476BCGJMG6OHOIJM8C6BD4JM06K9PA6S46IPDI3OCCI1",
        "name": "wpsadmin",
        "type": "USER"
      },
      "aggregateResults": [
        {
          "statusCode": "Error",
          "title": "some text",
          "type": "",
          "errorMessage": "Failed to find controllable: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, com.aptrix.pluto.control.Controllable}, in vp instance: 0, with context pathnull, and hostname: null",
          "createdBy": "",
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        },
        {
          "statusCode": "Error",
          "title": "some text",
          "type": "",
          "errorMessage": "Failed to find controllable: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx, com.aptrix.pluto.control.Controllable}, in vp instance: 0, with context pathnull, and hostname: null",
          "createdBy": "",
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        }
      ]
    },
    {
      "pollingId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "totalNumBulkItems": "1",
      "numBulkItemsProcessed": "1",
      "startTime": "Wed May 17 19:29:06 UTC 2023",
      "stopTime": "Wed May 17 19:29:06 UTC 2023",
      "numItemsSuccess": "1",
      "numItemsFail": "0",
      "status": "COMPLETE",
      "action": "updateExpiry",
      "creator": {
        "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
        "uri": "/wps/mycontenthandler/!ut/p/digest!mBVmxcmpiAZ_U6GQaRauzw/um/users/profiles/Z9eAePPC8MQ866BO4JM476BCGJMG6OHOIJM8C6BD4JM06K9PA6S46IPDI3OCCI1",
        "name": "wpsadmin",
        "type": "USER"
      },
      "aggregateResults": [
        {
          "statusCode": "OK",
          "title": "some text",
          "type": "object type",
          "createdBy": "wpsadmin",
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "link": "/wps/mycontenthandler/!ut/p/digest!mBVmxcmpiAZ_U6GQaRauzw/wcmrest/SiteArea/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?mime-type=application%2Fjson"
        }
      ]
    },
    {
      "pollingId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "totalNumBulkItems": "2",
      "numBulkItemsProcessed": "2",
      "startTime": "Wed May 17 19:28:50 UTC 2023",
      "stopTime": "Wed May 17 19:28:50 UTC 2023",
      "numItemsSuccess": "2",
      "numItemsFail": "0",
      "status": "COMPLETE",
      "action": "updateExpiry",
      "creator": {
        "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
        "uri": "/wps/mycontenthandler/!ut/p/digest!mBVmxcmpiAZ_U6GQaRauzw/um/users/profiles/Z9eAePPC8MQ866BO4JM476BCGJMG6OHOIJM8C6BD4JM06K9PA6S46IPDI3OCCI1",
        "name": "wpsadmin",
        "type": "USER"
      },
      "aggregateResults": [
        {
          "statusCode": "OK",
          "title": "some text",
          "type": "object type",
          "createdBy": "wpsadmin",
          "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
          "link": "/wps/mycontenthandler/!ut/p/digest!mBVmxcmpiAZ_U6GQaRauzw/wcmrest-v2/contents/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
        },
        {
          "statusCode": "OK",
          "title": "some text",
          "type": "object type",
          "createdBy": "wpsadmin"
        }
      ]
    }
  ]
}
```

--------------------------------

### ConfigCommon Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

Shows a configuration option with its name and enabled status. Use this to represent settings.

```json
{
  "name": "ENABLE_WORKFLOW",
  "enabled": false
}
```

--------------------------------

### Initialize Redoc with Configuration Options

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/access-api/index.html

Initializes the Redoc documentation interface with custom configuration options, including theme settings and API specification path.

```javascript
var configOptions = {
  hideLoading: true,
  theme: {
    colors: {
      primary: { main: "#6A2E99" },
      text: { primary: "#000000" },
      success: { main: '#04633D' },
      warning: { main: '#AE3D04' },
      error: { main: '#C10D' },
    },
    typography: {
      fontFamily: 'Helvetica Neue, Arial, sans-serif',
      headings: {
        fontFamily: 'Helvetica Neue, Arial, sans-serif'
      },
      code: {
        fontFamily: 'Helvetica Neue, Arial, sans-serif'
      }
    },
    sidebar: {
      backgroundColor: "#F2F4F5",
      textColor: "#3D5466"
    },
    logo: {
      gutter: "12.5px"
    }
  }
};
Redoc.init("./openapi.json", configOptions, document.getElementById('redoc-container'))
```

--------------------------------

### GET /dx/api/people/v1/user-directories/users/{guid}

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/people_service.md

Retrieves and consolidates the profile of a single user from all user directories. Fetches detailed profile information for a specific user, identified by their GUID, from all configured user directories, including LDAP, Active Directory, and custom data sources. The consolidated profile provides a comprehensive view of the user's details as aggregated across these directories.

```APIDOC
## GET /dx/api/people/v1/user-directories/users/{guid}

### Description
Retrieves and consolidates the profile of a single user from all user directories. Fetches detailed profile information for a specific user, identified by their GUID, from all configured user directories, including LDAP, Active Directory, and custom data sources. The consolidated profile provides a comprehensive view of the user's details as aggregated across these directories.

### Method
GET

### Endpoint
/dx/api/people/v1/user-directories/users/{guid}

### Parameters
#### Path Parameters
- **guid** (string) - Required - 

### Responses
#### Success Response (200)
- Successfully retrieved and consolidated the user profile from all directories.

#### Error Response (400)
- Invalid request parameters.
#### Error Response (401)
- Unauthorized. The request is missing a valid session.
#### Error Response (404)
- Person not found.
```

--------------------------------

### Initialize WCM API with Configuration

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/wcm-api/index.html

Initializes the WCM API using Redoc with custom configuration options for theme, typography, and sidebar.

```javascript
var configOptions = { hideLoading: true, theme: { colors:{ primary: { main: "#6A2E99" }, text: { primary: "#000000" }, success: { main: '#04633D' }, warning: { main: '#AE3D04' }, error: { main: '#C10C0D' }, }, typography: { fontFamily: 'Helvetica Neue, Arial, sans-serif', headings: { fontFamily: 'Helvetica Neue, Arial, sans-serif' }, code: { fontFamily: 'Helvetica Neue, Arial, sans-serif' } }, sidebar: { backgroundColor: "#F2F4F5", textColor: "#3D5466" }, logo: { gutter: "12.5px" } } }; Redoc.init("./openapi.json", configOptions, document.getElementById('redoc-container'))
```

--------------------------------

### WorkflowRemoveResponse JSON Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

This is an example of the WorkflowRemoveResponse JSON structure, showing the properties and their potential values.

```json
{
  "message": "Rejected by user wpsadmin - From stage Expire Stage to Draft Stage"
},
{
  "date": "Thu, 14 Dec 2023 10:42:30.485Z",
  "name": "wpsadmin",
  "message": "Document updated by wpsadmin"
}
]
}
}
```

--------------------------------

### Initialize Personalization API with Redoc

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/pzn-api/index.html

Initializes the Redoc documentation interface with custom configuration options. Ensure the 'redoc-container' element exists in your HTML.

```javascript
var configOptions = {
  hideLoading: true,
  theme: {
    colors: {
      primary: { main: "#6A2E99" },
      text: { primary: "#000000" },
      success: { main: '#04633D' },
      warning: { main: '#AE3D04' },
      error: { main: '#C10C0D' },
    },
    typography: {
      fontFamily: 'Helvetica Neue, Arial, sans-serif',
      headings: {
        fontFamily: 'Helvetica Neue, Arial, sans-serif'
      },
      code: {
        fontFamily: 'Helvetica Neue, Arial, sans-serif'
      }
    },
    sidebar: {
      backgroundColor: "#F2F4F5",
      textColor: "#3D5466"
    },
    logo: {
      gutter: "12.5px"
    }
  }
};
Redoc.init("./openapi.json", configOptions, document.getElementById('redoc-container'))
```

--------------------------------

### Project Request Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

This JSON object is used to create or update a project. It defines project details including title, description, and content configuration.

```json
{
  "entry": {
    "title": {
      "lang": "en-GB",
      "value": "Project Title"
    },
    "x-logo": {
      "url": "../DX_logo.svg",
      "backgroundColor": "#F2F4F5",
      "altText": "HCL_Digital_Experience"
    },
    "description": {
      "lang": "en-GB",
      "value": "Project Description"
    },
    "name": "Project Name",
    "type": "Project",
    "content": {
      "type": "application/vnd.ibm.wcm+xml",
      "project": {
        "approvers": {
          "approver": [
            {
              "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
              "uri": "/wps/mycontenthandler/!ut/p/digest!3Jx9iQ9BIUqLVJyT2onokw/um/users/profiles/Z9eAe63EG3OKCM9O2MMG66JOGJMG6J9PIJM07MHC8JMO6I9P0JG5CLHC8MGDCG1",
              "name": "wpsadmin",
              "type": "USER"
            }
          ]
        },
        "approvalRequiredFrom": "ANY_APPROVER",
        "commentOnReview": "NEVER",
        "publishOption": "MANUAL"
      }
    }
  }
}
```

--------------------------------

### DateComponentRequest Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

An example of a DateComponentRequest object, showing its structure for representing date and time information.

```json
{
  "entry": {
    "title": {
      "lang": "en",
      "value": "Date and time test 1"
    },
    "summary": {
      "lang": "en",
      "value": "Date and time test 1"
    },
    "name": "Date and time test 1",
    "type": "LibraryDateComponent",
    "link": [
      {
        "rel": "library",
        "href": "/wps/mycontenthandler/!ut/p/digest!V_JajH5youtNrBX3nhABiA/wcmrest-v2/libraries/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "lang": "en",
        "label": "Library"
      }
    ],
    "content": {
      "type": "application/vnd.ibm.wcm+xml",
      "date": {
        "type": "DateTime",
        "value": "Thu, 05 Oct 2023 01:00:00.000Z"
      }
    }
  }
}
```

--------------------------------

### IFolderPostBody Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

Payload for creating a new folder. Requires a title and optionally accepts a description, parent ID, and logo configuration.

```json
{
  "title": "demo",
  "x-logo": {
    "url": "../DX_logo.svg",
    "backgroundColor": "#F2F4F5",
    "altText": "HCL_Digital_Experience"
  },
  "description": "demo folder",
  "parentId": "b7bbddd7-95c6-4062-8971-134f780002f1"
}
```

--------------------------------

### GET /contentsources/{contentsource_id}/documents

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/endpoints.md

Get document ids from index given as contentsource_id (getContentsourcesDocuments).

```APIDOC
## GET /contentsources/{contentsource_id}/documents

### Description
Get document ids from index given as contentsource_id (getContentsourcesDocuments).

### Method
GET

### Endpoint
`/contentsources/{contentsource_id}/documents`
```

--------------------------------

### GET /contentsources/{contentsource_id}/documents/{document_id}

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/endpoints.md

Get single document from index given as contentsource_id (getContentsourcesDocumentsById).

```APIDOC
## GET /contentsources/{contentsource_id}/documents/{document_id}

### Description
Get single document from index given as contentsource_id (getContentsourcesDocumentsById).

### Method
GET

### Endpoint
`/contentsources/{contentsource_id}/documents/{document_id}`
```

--------------------------------

### ProjectWithdrawApprovalResponse Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

This JSON object illustrates the structure of a ProjectWithdrawApprovalResponse, including project details, author, owner, and links for various actions.

```json
{
  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "title": {
    "lang": "en-GB",
    "value": "Project Title"
  },
  "x-logo": {
    "url": "../DX_logo.svg",
    "backgroundColor": "#F2F4F5",
    "altText": "HCL_Digital_Experience"
  },
  "description": {
    "lang": "en-GB",
    "value": "Project Description"
  },
  "name": "Project Name",
  "type": "Project",
  "updated": "Thu, 14 Dec 2023 10:48:36.504Z",
  "created": "Thu, 14 Dec 2023 09:03:02.243Z",
  "author": [
    {
      "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
      "uri": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/um/users/profiles/Z9eAe43E83P47J9DAJM46JHDAJMG6PPD6MM47I1D4MMOCOHCA3S863BE63P07L1",
      "name": "wpsadmin",
      "type": "USER"
    }
  ],
  "owner": [
    {
      "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
      "uri": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/um/users/profiles/Z9eAe43E83P47J9DAJM46JHDAJMG6PPD6MM47I1D4MMOCOHCA3S863BE63P07L1",
      "name": "wpsadmin",
      "type": "USER"
    }
  ],
  "lastModifier": {
    "distinguishedName": "SystemUser",
    "name": "SystemUser",
    "type": "USER"
  },
  "creator": {
    "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
    "uri": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/um/users/profiles/Z9eAe43E83P47J9DAJM46JHDAJMG6PPD6MM47I1D4MMOCOHCA3S863BE63P07L1",
    "name": "wpsadmin",
    "type": "USER"
  },
  "link": [
    {
      "rel": "self",
      "href": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/wcmrest-v2/Project/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "lang": "en",
      "label": "Read"
    },
    {
      "rel": "edit",
      "href": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/wcmrest-v2/Project/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "lang": "en",
      "label": "Edit"
    },
    {
      "rel": "delete",
      "href": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/wcmrest-v2/Project/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "lang": "en",
      "label": "Delete"
    },
    {
      "rel": "access-control",
      "href": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/ac/access:oid:Z6QSeDe2JD26R86NPDCMMK6MPC6MMG6P9E6JM07I9C6MMO6KHPAMP8CH9C83JL613",
      "lang": "en",
      "label": "Access Control"
    },
    {
      "rel": "edit-media",
      "href": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/wcmrest-v2/Project/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "type": "application/vnd.ibm.wcm+xml",
      "lang": "en",
      "label": "Edit Media"
    },
    {
      "rel": "withdraw-from-review",
      "href": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/wcmrest-v2/item/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/withdraw-from-review",
      "lang": "en",
      "label": "Withdraw From Review"
    },
    {
      "rel": "approve",
      "href": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/wcmrest-v2/item/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/approve",
      "lang": "en",
      "label": "Approve"
    },
    {
      "rel": "reject",
      "href": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/wcmrest-v2/item/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/reject",
      "lang": "en",
      "label": "Reject"
    },
    {
      "rel": "project-items",
      "href": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/wcmrest-v2/Project/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/project-items",
      "lang": "en",
      "label": "Project Items"
    },
    {
      "rel": "new-projecttemplate",
      "href": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/wcmrest-v2/Project/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/new-projecttemplate",
      "lang": "en",
      "label": "New Project Template"
    }
  ],
  "category": [
    {
      "scheme": "wcmrest:favorite",
      "term": "false",
      "lang": "en"
    },
    {
      "scheme": "wcmrest:projectState",
      "term": "REVIEW",
      "label": "Review",
      "lang": "en"
    }
  ],
  "content": {
    "type": "application/vnd.ibm.wcm+xml",
    "project": {
      "approvers": {
        "approver": [
          {
            "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
            "uri": "/wps/mycontenthandler/!ut/p/digest!XOfciMuKL9V_maPKtXl8-g/um/users/profiles/Z9eAe43E83P47J9DAJM46JHDAJMG6PPD6MM47I1D4MMOCOHCA3S863BE63P07L1",
            "name": "wpsadmin",
            "type": "USER"
          }
        ]
      },
      "approvalRequiredFrom": "ANY_APPROVER",
      "commentOnReview": "NEVER",
      "publishOption": "MANUAL"
    }
  }
}
```

--------------------------------

### Initialize People Service API with Redoc

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/people-service-api/index.html

Initializes the Redoc documentation interface for the People Service API. Requires an OpenAPI specification file and configuration options.

```javascript
var configOptions = {
  hideLoading: true,
  theme: {
    colors: {
      primary: {
        main: "#6A2E99"
      },
      text: {
        primary: "#000000"
      },
      success: {
        main: '#04633D'
      },
      warning: {
        main: '#AE3D04'
      },
      error: {
        main: '#C10C0D'
      },
    },
    typography: {
      fontFamily: 'Helvetica Neue, Arial, sans-serif',
      headings: {
        fontFamily: 'Helvetica Neue, Arial, sans-serif'
      },
      code: {
        fontFamily: 'Helvetica Neue, Arial, sans-serif'
      }
    },
    sidebar: {
      backgroundColor: "#F2F4F5",
      textColor: "#3D5466"
    },
    logo: {
      gutter: "12.5px"
    }
  }
};
Redoc.init("./openapi.json", configOptions, document.getElementById('redoc-container'))
```

--------------------------------

### GET /Syndication/Syndicators

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/errors.md

Handles 404 errors for GET requests to retrieve syndicators. Indicates the item was not found.

```APIDOC
## GET /Syndication/Syndicators

### Description
This endpoint is used to retrieve syndicators. A 404 error is returned if the syndicators are not found.

### Method
GET

### Endpoint
/Syndication/Syndicators

### Response
#### Error Response (404)
- **message** (string) - Item not Found
```

--------------------------------

### Project Data Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

Represents project data including publish options, approval requirements, and state.

```json
{
  "publish-option": "manual",
  "approvalRequired": [
    {
      "distinguishedName": "Camille Marshal",
      "uri": "some text",
      "name": "Camille Marshal",
      "type": "some text"
    },
    {
      "distinguishedName": "Camille Marshal",
      "uri": "some text",
      "name": "Camille Marshal",
      "type": "some text"
    }
  ],
  "publish-date": "some text",
  "state": {},
  "comment-required": true,
  "custom-action": {}
}
```

--------------------------------

### EmptyJson Object Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

This is an example of an empty JSON object, often used as a placeholder or for responses that contain no data.

```json
{}
```

--------------------------------

### IFolderDetails Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

Represents the details of a folder, including its ID, title, description, creation and modification timestamps, and parent information.

```json
{
  "id": "b7bbddd7-95c6-4062-8971-134f780002f1",
  "x-logo": {
    "url": "../DX_logo.svg",
    "backgroundColor": "#F2F4F5",
    "altText": "HCL_Digital_Experience"
  },
  "description": "Demo folder",
  "title": "DemoFolder",
  "parentId": "ffbbddd7-95c6-4062-8971-134f780002f1",
  "authors": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
  "creator": "wpsadmin",
  "created": "2021-09-30T11:25:57.090Z",
  "lastModified": "2021-09-30T11:25:57.090Z",
  "lastModifier": "wpsadmin"
}
```

--------------------------------

### GET /Syndication/Subscribers

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/errors.md

Handles 404 errors for GET requests to retrieve syndication subscribers. Indicates the item was not found.

```APIDOC
## GET /Syndication/Subscribers

### Description
This endpoint is used to retrieve syndication subscribers. A 404 error is returned if the subscribers are not found.

### Method
GET

### Endpoint
/Syndication/Subscribers

### Response
#### Error Response (404)
- **message** (string) - Item not Found
```

--------------------------------

### Initialize DAM API with Configuration

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/dam-api/index.html

Initializes the DAM API using Redoc with custom configuration options. This includes setting theme colors, typography, sidebar styles, and logo gutter. Ensure './openapi.json' is the correct path to your OpenAPI specification.

```javascript
var configOptions = {
  hideLoading: true,
  theme: {
    colors: {
      primary: { main: "#6A2E99" },
      text: { primary: "#000000" },
      success: { main: '#04633D' },
      warning: { main: '#AE3D04' },
      error: { main: '#C10D0D' },
    },
    typography: {
      fontFamily: 'Helvetica Neue, Arial, sans-serif',
      headings: {
        fontFamily: 'Helvetica Neue, Arial, sans-serif'
      },
      code: {
        fontFamily: 'Helvetica Neue, Arial, sans-serif'
      }
    },
    sidebar: {
      backgroundColor: "#F2F4F5",
      textColor: "#3D5466"
    },
    logo: {
      gutter: "12.5px"
    }
  }
};
Redoc.init("./openapi.json", configOptions, document.getElementById('redoc-container'))
```

--------------------------------

### GET /SiteAreaTemplate/{item-uuid}

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/errors.md

Handles 404 errors for GET requests to retrieve a SiteAreaTemplate. Indicates the item was not found.

```APIDOC
## GET /SiteAreaTemplate/{item-uuid}

### Description
This endpoint is used to retrieve a SiteAreaTemplate. A 404 error is returned if the specified item-uuid does not exist.

### Method
GET

### Endpoint
/SiteAreaTemplate/{item-uuid}

### Parameters
#### Path Parameters
- **item-uuid** (string) - Required - The unique identifier for the SiteAreaTemplate.

### Response
#### Error Response (404)
- **message** (string) - Item was not found
```

--------------------------------

### GET /recent-items

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/errors.md

Handles 404 errors for GET requests to retrieve recent items. Indicates the item was not found.

```APIDOC
## GET /recent-items

### Description
This endpoint is used to retrieve recent items. A 404 error is returned if recent items cannot be found.

### Method
GET

### Endpoint
/recent-items

### Response
#### Error Response (404)
- **message** (string) - Item was not found
```

--------------------------------

### Initialize Ring API with Configuration

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/ring-api/index.html

Initializes the Redoc documentation interface with a specified OpenAPI JSON file and custom configuration options. The configuration allows for theming, hiding loading indicators, and setting typography.

```javascript
var configOptions = { hideLoading: true, theme: { colors:{ primary: { main: "#6A2E99" }, text: { primary: "#000000" }, success: { main: '#04633D' }, warning: { main: '#AE3D04' }, error: { main: '#C10D0D' }, }, typography: { fontFamily: 'Helvetica Neue, Arial, sans-serif', headings: { fontFamily: 'Helvetica Neue, Arial, sans-serif' }, code: { fontFamily: 'Helvetica Neue, Arial, sans-serif' } }, sidebar: { backgroundColor: "#F2F4F5", textColor: "#3D5466" }, logo: { gutter: "12.5px" } } }; Redoc.init("./openapi.json", configOptions, document.getElementById('redoc-container'))
```

--------------------------------

### ItemVersionResponse Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

Represents a list of item versions returned by the WCM API. Each entry includes version details and links.

```json
{
  "entry": [
    {
      "versionContent": {
        "versionName": "2",
        "versionDate": "Wed, 21 Feb 2024 11:39:21.109Z"
      },
      "link": [
        {
          "rel": "versioned-item",
          "href": "/wps/mycontenthandler/!ut/p/digest!4WO1QMmoSJsVoZSCIdhQIg/wcmrest/item/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/version/2",
          "lang": "en",
          "label": "Versioned Item"
        }
      ]
    },
    {
      "versionContent": {
        "versionName": "1",
        "versionDate": "Wed, 21 Feb 2024 11:39:20.750Z"
      },
      "link": [
        {
          "rel": "versioned-item",
          "href": "/wps/mycontenthandler/!ut/p/digest!4WO1QMmoSJsVoZSCIdhQIg/wcmrest/item/xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/version/1",
          "lang": "en",
          "label": "Versioned Item"
        }
      ]
    }
  ]
}
```

--------------------------------

### GET /Project/{project_uuid}

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/errors.md

Handles 404 errors for GET requests to retrieve a Project. Indicates the item was not found.

```APIDOC
## GET /Project/{project_uuid}

### Description
This endpoint is used to retrieve a Project. A 404 error is returned if the specified project_uuid does not exist.

### Method
GET

### Endpoint
/Project/{project_uuid}

### Parameters
#### Path Parameters
- **project_uuid** (string) - Required - The unique identifier for the Project.

### Response
#### Error Response (404)
- **message** (string) - Item was not found
```

--------------------------------

### GET /PresentationTemplate/{presentation_template_id}

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/errors.md

Handles 404 errors for GET requests to retrieve a PresentationTemplate. Indicates the item was not found.

```APIDOC
## GET /PresentationTemplate/{presentation_template_id}

### Description
This endpoint is used to retrieve a PresentationTemplate. A 404 error is returned if the specified presentation_template_id does not exist.

### Method
GET

### Endpoint
/PresentationTemplate/{presentation_template_id}

### Parameters
#### Path Parameters
- **presentation_template_id** (string) - Required - The unique identifier for the PresentationTemplate.

### Response
#### Error Response (404)
- **message** (string) - Item was not found
```

--------------------------------

### GET /dx/api/people/v1/probes/startup

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/endpoints.md

Checks the startup of the service. Assesses the startup of the service, ensuring the service will not get cleaned up before startup finishes. This is called only in the beginning phase in the lifecycle of the service.

```APIDOC
## GET /dx/api/people/v1/probes/startup

### Description
Checks the startup of the service. Assesses the startup of the service, ensuring the service will not get cleaned up before startup finishes. This is called only in the beginning phase in the lifecycle of the service.

### Method
GET

### Endpoint
/dx/api/people/v1/probes/startup

### Response
#### Success Response (200)
Service has started up now.

#### Error Response (500)
Service is still starting up.

### Security
Required
```

--------------------------------

### ProjectTemplateResponse Example

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/types.md

Represents the response when retrieving a project template. It includes metadata like title, name, type, update timestamp, author, owner, creator, and the content of the template. This is typically returned by WCM API calls that fetch project template details.

```json
{
  "title": {
    "lang": "en"
  },
  "name": "",
  "type": "ProjectTemplate",
  "updated": "Fri, 22 Dec 2023 15:07:11.405Z",
  "author": [
    {
      "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
      "uri": "/wps/mycontenthandler/!ut/p/digest!jMrtuqygNNoRCiEP7Ei2hg/um/users/profiles/Z9eAe63EG3OKCM9O2MMG6J9PIJM07MHC8JMO6I9P0JG5CLHC8MGDCG1",
      "name": "wpsadmin",
      "type": "USER"
    }
  ],
  "owner": [
    {
      "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
      "uri": "/wps/mycontenthandler/!ut/p/digest!jMrtuqygNNoRCiEP7Ei2hg/um/users/profiles/Z9eAe63EG3OKCM9O2MMG6J9PIJM07MHC8JMO6I9P0JG5CLHC8MGDCG1",
      "name": "wpsadmin",
      "type": "USER"
    }
  ],
  "creator": {
    "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
    "uri": "/wps/mycontenthandler/!ut/p/digest!jMrtuqygNNoRCiEP7Ei2hg/um/users/profiles/Z9eAe63EG3OKCM9O2MMG6J9PIJM07MHC8JMO6I9P0JG5CLHC8MGDCG1",
    "name": "wpsadmin",
    "type": "USER"
  },
  "content": {
    "type": "application/vnd.ibm.wcm+xml",
    "project": {
      "approvers": {
        "approver": [
          {
            "distinguishedName": "uid=wpsadmin,o=defaultWIMFileBasedRealm",
            "uri": "/wps/mycontenthandler/!ut/p/digest!jMrtuqygNNoRCiEP7Ei2hg/um/users/profiles/Z9eAe63EG3OKCM9O2MMG6J9PIJM07MHC8JMO6I9P0JG5CLHC8MGDCG1",
            "name": "wpsadmin",
            "type": "USER"
          }
        ]
      },
      "approvalRequiredFrom": "ANY_APPROVER",
      "commentOnReview": "NEVER",
      "publishOption": "MANUAL"
    }
  }
}
```

--------------------------------

### GET /PortalPage/{portal_page_id}

Source: https://github.com/hcl-tech-software/experience-api-documentation/blob/master/_autodocs/errors.md

Handles 404 errors for GET requests to retrieve a PortalPage. Indicates the item was not found.

```APIDOC
## GET /PortalPage/{portal_page_id}

### Description
This endpoint is used to retrieve a PortalPage. A 404 error is returned if the specified portal_page_id does not exist.

### Method
GET

### Endpoint
/PortalPage/{portal_page_id}

### Parameters
#### Path Parameters
- **portal_page_id** (string) - Required - The unique identifier for the PortalPage.

### Response
#### Error Response (404)
- **message** (string) - Not Found
```