Create REST Message

To invoke AvePoint Cloud Governance APIs, you must create a REST message in ServiceNow by completing the following configurations:

- [REST Message Basic Information](#missing-link)

- [Add HTTP Headers](../../appendices/appendix-e--integration-with-servicenow/create-rest-message.md#add-http-headers)

- [Add HTTP Methods](../../appendices/appendix-e--integration-with-servicenow/create-rest-message.md#add-http-methods)

- [Test the API](#missing-link)

	> ***Note**: This is required only when you want to test the newly added AvePoint Cloud Governance API. If you don’t need to test the API, skip configurations in this section.

REST Message Basic Information

Complete the following steps to start creating a REST message:

Sign in to your ServiceNow instance with an account that has the admin role.
On the left navigation pane, enter REST Message in the search box, and then click REST Message in the search results.
On the REST Messages page, click New to open the REST Message – New Record page.
On the REST Message – New Record page, complete the following configurations:
- Name – Enter a name for the REST API.
- Endpoint – Enter ${data_center_url}/requests.
  
  *Note: The data_center_url is a sample value, it is a variable, and you can enter a custom one. This will also be used in the next configurations.
- Application – Click the Preview this record () icon next to the Application field, and navigate to the Scope field on the Custom Application page. Make sure to copy this application scope to your Notepad, and it will be used in the Create System Properties and Run Script to Submit Requests sections.

Add HTTP Headers

Then, you need to add HTTP headers by completing the following steps:

Under the HTTP Request tab, double click the text box, enter the name and values in the Name and Value fields as listed in the table below, and then click the Save () button when you finish.

Name	Value
ClientSecret	Enter ${gao_api_clientsecret}.*Note: This is a sample header name, and you can enter a custom name within ${xxx}.
Content-Type	Enter application/json.
UserPrincipalName	Enter ${gao_user_name}.*Note: This is a sample header name, and you can enter a custom name within ${xxx}.

After you add all HTTP headers, click Submit and you will be redirected to the REST Messages page.

Add HTTP Methods

Then, you need to add HTTP methods for the REST message by completing the following steps:

On the **REST Messages** page, click the message you’ve just created.

Navigate to the **HTTP Methods** field and click **New** to open the **HTTP Method** **– New Record** page. Then, configure the following fields:

- **Name** – Enter a custom name for the HTTP method. 

- **HTTP Method** – Select **POST** from the drop-down list.

- **Endpoint** – Enter the endpoint that this REST message is sent. The endpoint URL varies with a service type, you can refer to the endpoint URL listed in the table below for different service types:

Service Type	Endpoint URL
Invite new guest user service	Enter ${data_center_url}/requests/createguestuser.
Create group/team service	Enter ${data_center_url}/requests/creategroup.
Change group/team service	Enter ${data_center_url}/requests/changegroup.
Team lifecycle management service – Restore team	Enter ${data_center_url}/requests/restoregroup.
Team lifecycle management service – Delete team	Enter ${data_center_url}/requests/deletegroup.
Team lifecycle management service – Archive team	Enter ${data_center_url}/requests/archivegroup.
Team lifecycle management service – Change group team site storage	Enter ${data_center_url}/requests/changegroupquota.
Team lifecycle management service – Change team policy	Enter ${data_center_url}/requests/changegrouppolicy.
Team lifecycle management – Extend team lease	Enter ${data_center_url}/requests/extendgroup.
Create site collection service	Enter ${data_center_url}/requests/createsite.
Change site collection settings service	Enter ${data_center_url}/requests/changesite/setting.
Site collection lifecycle management service – Delete site collection	Enter ${data_center_url}/requests/deletesite.
Site collection lifecycle management service – Unlock site collection	Enter ${data_center_url}/requests/unlocksite.
Site collection lifecycle management service – Lock site collection	Enter ${data_center_url}/requests/locksite.
Site collection lifecycle management service – Archive site collection	Enter ${data_center_url}/requests/archivesite.
Site collection lifecycle management service – Extend site collection lease	Enter ${data_center_url}/requests/extendsite.
Site collection lifecycle management service – Change site collection storage	Enter ${data_center_url}/requests/changesitequota.
Site collection lifecycle management service – Change site collection policy	Enter ${data_center_url}/requests/changesitepolicy.

When you finish, click Submit. Then you will be redirected to the REST Message page.

Test the API

To test the API you’ve just added, complete the following steps:

Navigate to the HTTP Methods field, and click the HTTP method you’ve just created.
On the HTTP Method page, navigate to the Variable Substitutions tab, and then click New to open the Variable Substitutions – New Record page.
Configure the Name and Test value fields.

Repeat the steps above to add all variable substitutions as listed in the table below:

Name	Value
data_center_url	Enter https://go-api.avepointonlineservices.com if the AvePoint Cloud Governance environment you are using is the production environment for commercial use.Enter https://governance-api-us-gov.avepointonlineservices.com if the AvePoint Cloud Governance environment you are using is the production environment for U.S. Government Public Sector.
gao_api_clientsecret	Enter the client secret that you copied in the Manage API Authentication Profiles section.
gao_user_name	Enter the sign-in name of an AvePoint Cloud Governance user. *Note: Make sure the user has been added to AvePoint Online Services and has a subscription for AvePoint Cloud Governance.

When you finish, click **Submit**. Then you will be redirected to the **HTTP Method** page.

4. Navigate to the HTTP Request tab > HTTP Query Parameters, and enter the content in the Content field. See examples below for different service types.

Click Test to test the AvePoint Cloud Governance API.

Create Team

This is a sample for a Create team service request API testing.

For more information about the script, refer to the schema provided by AvePoint Cloud Governance in the AvePoint Cloud Governance API.

{ "groupDescription": "", "groupId": "DemoTeam", "groupName": " DemoTeam ", "members": [{ "loginName": "Demo@domain.com", }], "owners": [{ "loginName": " Demo@domain.com ", }], "policy": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "primaryContact": { "loginName": " Demo1@domain.com ", }, "secondaryContact": { "loginName": " Demo2@domain.com ", }, "serviceId": " xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx ", "summary": "DemoTeam", "teamsSettings": { }, "templateSettings": { "enableCreateTeamFromScratch": true, "enableCreateTeamFromExistTeam": false, "enableCreateTeamFromTeamTemplate": false }}