### Example: Get All Content Items with Admin Privileges

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/http-headers-43a48d5.md

Demonstrates how to retrieve all content items in a workspace, even if the company administrator is not a member, using the SAP-JAM-CONTENT-ADMINISTRATION header.

```http
Request Url: GET {{api_url}}/Groups('{{Id}}')/AllContentItems
Header: Authorization: Bearer {OAuth_bearer_token}
Header: SAP-JAM-CONTENT-ADMINISTRATION: true
```

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

### Sort Fields Configuration Example

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/odata-assumptions-9e66b96.md

Provides an example of how to format sort field entries in the 'Sort Fields' text box. Each field must start with an ampersand and be comma-separated.

```text
&thePropertyYouJustAdded
```

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

### Log Event: Finish Installing Content Package

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/auditing-and-logging-information-b1c760e.md

Logs the successful installation of a content package, including package ID and version.

```text
Installed WorkZone Content Package: ${packageID}, version: ${version}
```

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

### Initial Design Time Module Setup

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/20-UIIntegrationCards/creating-a-design-time-module-f93b625.md

Add this initial setup to your `dt/configuration.js` file. It initializes the Designtime object with form and preview configurations.

```javascript
sap.ui.define(["sap/ui/integration/Designtime"], function (
	Designtime
) {
	"use strict";
	return function () {
		return new Designtime({
			form: {
				items: {
					//here goes the configuration
				}
			},
			preview: {
				modes: "Abstract"
			}
		});
	};
});
```

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

### Log Event: Fail to Install Content Package

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/auditing-and-logging-information-b1c760e.md

Logs a failed installation of a content package, including package ID and version.

```text
Failed to install WorkZone Content Package: ${packageID}, version: ${version}
```

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

### Annotations Markup Example

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/develop-an-odata-annotations-file-to-display-business-records-2332e84.md

Example of an Annotations file defining UI.HeaderInfo, UI.Identification, and UI.LineItem for a SugarCRM Contact.

```xml
<Annotations Target="SugarCRM.Contact">
    <Annotation Term="UI.HeaderInfo">
        <Record>
            <PropertyValue Property="TypeName" String="Contact"/>
            <PropertyValue Property="ImageUrl" String="/images/exobj/account/account_grey_48.png"/>
            <PropertyValue Property="Title">
                <Record>
                    <PropertyValue Property="Value" Path="name"/>
                </Record>
            </PropertyValue>
        </Record>
    </Annotation>
    <Annotation Term="UI.Identification">
        <Collection>
            <Record Type="UI.DataField">
                <PropertyValue Property="Label" String="Name"/>
                <PropertyValue Property="Value" Path="full_name"/>
            </Record>
            <Record Type="UI.DataField">
                <PropertyValue Property="Label" String="Title"/>
                <PropertyValue Property="Value" Path="title"/>
            </Record>
            <Record Type="UI.DataField">
                <PropertyValue Property="Label" String="E-Mail"/>
                <PropertyValue Property="Value" Path="email1"/>
            </Record>
            <Record Type="UI.DataField">
                <PropertyValue Property="Label" String="Office Phone"/>
                <PropertyValue Property="Value" Path="phone_work"/>
            </Record>
            <Record Type="UI.DataField">
                <PropertyValue Property="Label" String="Mobile Phone"/>
                <PropertyValue Property="Value" Path="phone_mobile"/>
            </Record>
        </Collection>
    </Annotation>
    <Annotation Term="UI.LineItem">
        <Collection>
            <Record Type="UI.DataField">
                <PropertyValue Property="Label" String="Name"/>
                <PropertyValue Property="Value" Path="full_name"/>
            </Record>
            <Record Type="UI.DataField">
                <PropertyValue Property="Label" String="E-Mail"/>
                <PropertyValue Property="Value" Path="email1"/>
            </Record>
            <Record Type="UI.DataField">
                <PropertyValue Property="Label" String="Office Phone"/>
                <PropertyValue Property="Value" Path="phone_work"/>
            </Record>
            <Record Type="UI.DataField">
                <PropertyValue Property="Label" String="Mobile Phone"/>
                <PropertyValue Property="Value" Path="phone_mobile"/>
            </Record>
        </Collection>
    </Annotation>
</Annotations>
```

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

### Log Event: Create Installing Deploy Job

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/auditing-and-logging-information-b1c760e.md

Logs the creation of a deploy job for installing a content package, including package ID and version.

```text
Installing WorkZone Content Package: ${packageID}, version: ${version}
```

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

### Related Object Navigation URI Example

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/odata-assumptions-9e66b96.md

Example of a navigation URI for a related object that includes query parameters for formatting, sorting, and pagination.

```uri
"https://domain/EntitySet('00163E03A0701')/Opportunity?$format=json&$orderby=ChangedOn+desc&$top=20&$skip=20"
```

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

### Example Host URL for Chatbot

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/50-Chatbots/chatbot-actions-f640146.md

This is an example of a host URL for your company's SAP Build Work Zone instance. Ensure this is correctly configured in your chatbot's webhook settings.

```text
https://dwpdev1.sapjam-integration.com
```

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

### Filter Properties Configuration Example

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/odata-assumptions-9e66b96.md

Shows an example of how filter properties should be entered in the 'Filter' text box. Properties must be marked as '$filterable' in the OData service.

```text
$filterable
```

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

### Form Item: label Examples

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/20-UIIntegrationCards/creating-a-design-time-module-f93b625.md

Examples of setting the `label` property for a form item. Labels can be fixed strings or bound to i18n translation keys.

```json
label : "fixedString"
```

```json
label : "{i18n>translatedStringKey}"
```

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

### Update Context Action Example

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/20-UIIntegrationCards/add-or-update-context-e69aef3.md

An example demonstrating how to use the 'updateContext' action to modify the card's context, triggered by a user interaction.

```javascript
"actions": [
                    {
                        "type": "updateContext",
                        "parameters": {
                            "namespace": "sap.cardcontextexample",
                            "context": {
                                "user": {
                                   "id": "1",
                                  "name": "Nick"
                                 }
                            }
                        }
                    }
                ]
          handleChange: function (oEvent) {
             var oComponent = this.getOwnerComponent(),
                 oCard = oComponent.oCard,
                 brand = oEvent.mParameters.value;

             oCard.triggerAction({
                 type: "updateContext",
                 parameters: {
                     "namespace": "sap.cardcontextexample",
                     "context": {
                         "brand": brand
                     }
                 }
             });
         }
 


```

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

### ImageUrl Property Example

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/develop-an-odata-annotations-file-to-display-business-records-2332e84.md

Use the ImageUrl property to specify the path to an image.

```xml
<PropertyValue Property="ImageUrl" String="/images/exobj/account/account_grey_48.png" />
```

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

### Example Card ID Configuration in Chatbot

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/50-Chatbots/render-cards-with-a-chatbot-449a2ba.md

This example shows how to correctly format the 'cardId' line within the webhook body configuration in SAP Conversational AI, using the unique ID of the card you want to render.

```json
"cardId":"sap.dwp.test.card.searchResult",
```

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

### Service Operations

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/urls-and-url-parameters-590de03.md

Service operations are endpoints that perform specific tasks not covered by standard CRUD operations. They are identified by underscores in their endpoint names. Exceptions include GET /Self, GET /Company, GET /Search, and GET /SearchSummary.

```APIDOC
## Service Operations

Service operations are endpoints that perform specific tasks not covered by standard CRUD operations. They are identified by underscores in their endpoint names. Exceptions include GET /Self, GET /Company, GET /Search, and GET /SearchSummary.

For more information, refer to the $metadata file or the OData documentation: [https://www.odata.org/documentation/](https://www.odata.org/documentation/)
```

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

### Form Item: visible Example

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/20-UIIntegrationCards/creating-a-design-time-module-f93b625.md

Example of setting the `visible` property to `true` for a form item. This controls the visibility of the field in the editor.

```json
visible: true
```

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

### Example: Search Content Items with Admin Privileges

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/http-headers-43a48d5.md

Shows how to search for content items across workspaces as a company administrator, irrespective of workspace membership, by including the SAP-JAM-CONTENT-ADMINISTRATION header.

```http
Request Url: GET {{api_url}}/Search?Query='{{search_item}}'
Header: Authorization: Bearer {OAuth_bearer_token}
Header: SAP-JAM-CONTENT-ADMINISTRATION: true
```

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

### Save Site Configuration

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/auditing-and-logging-information-b1c760e.md

This snippet demonstrates how to save site configuration changes. The placeholder `[<<DIFF>>]` should be replaced with the actual site diff content.

```json
Save site diff '[<<DIFF>>]'
```

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

### Form Item: required Example

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/20-UIIntegrationCards/creating-a-design-time-module-f93b625.md

Example of setting the `required` property to `true` for a form item. This indicates that the field is mandatory and will display an asterisk.

```json
required: true
```

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

### Form Item: manifestpath Example

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/20-UIIntegrationCards/creating-a-design-time-module-f93b625.md

Example of setting the `manifestpath` property for a form item. This property specifies the path to the manifest value to be edited.

```json
manifestpath : "sap.card/configuration/parameters/title/value"
```

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

### BRB URL Formatting Example

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/odata-assumptions-9e66b96.md

Demonstrates how to transform an OData $metadata URL to a direct BRB URL by removing the '$metadata#' fragment.

```text
https://example.com/odata/v1/c4c.svc/$metadata#CorporateAccountCollection
```

```text
https://example.com/odata/v1/c4c.svc/CorporateAccountCollection
```

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

### Sample Data for Request List

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/20-UIIntegrationCards/creating-a-design-time-module-f93b625.md

Example JSON structure for data provided by a request URL, used for populating string field lists.

```json
"values": [
		{ "text": "From JSON 1", "key": "key1" },
		{ "text": "From JSON 2", "key": "key2" },
		{ "text": "From JSON 3", "key": "key3" }
	]
```

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

### UI.ReferenceFacet Type Example

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/develop-an-odata-annotations-file-to-display-business-records-2332e84.md

Use UI.ReferenceFacet to reference another facet. Requires a label and a target annotation path.

```xml
<Record Type="UI.ReferenceFacet">
        <PropertyValue Property="Label" String="Overview" />
        <PropertyValue Property="Target" AnnotationPath="@UI.FieldGroup#Overview" />
    </Record>
```

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

### Constructed CRM Related Object URL Example

Source: https://github.com/sap-docs/btp-build-work-zone-advanced/blob/main/docs/odata-assumptions-9e66b96.md

Example of a constructed URL for retrieving CRM related objects, based on a navigation pattern and retrieved data.

```uri
"https://example.com/odata/ESJI_SD_SRV;o=QI3CLNT503_T/CustomerCollection(ObjectID='5')/Quotations"
```