### Get Playbook Configuration API Endpoint Examples

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Task_APIs

Examples of GET requests for the Get Playbook Configuration API. These demonstrate how to specify parameters like entity type ('et'), active status, and playbook type to filter the results.

```http
GET /v2/cockpit/admin/playbook?active=true &et=COMPANY_
```

```http
GET /v2/cockpit/admin/playbook?active=true &et=COMPANY&type=Risk,Expansion_
```

```http
GET /v2/cockpit/admin/playbook?et=COMPANY_
```

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

### Fetch Task List API Request Examples (GET)

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Task_APIs

These examples demonstrate how to call the Fetch Task List API using GET requests. They show variations with no query parameters, with page number and size specified, and with additional fields included.

```http
GET _/v2/cockpit/task/list/ <CTA_GSID>_
GET _/v2/cockpit/task/list/ <CTA_GSID>?pn=1&ps=500_
GET _/v2/cockpit/task/list/ <CTA_GSID>?includes=DT_Date__gc,DT_DateTime__gc_

```

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

### Sample Request for Fetch Download Links API (curl)

Source: https://support.gainsight.com/gainsight_nxt/Adoption_Explorer/Adoption_Explorer_API_Documentation/Adoption_Explorer_APIs

This is an example of a cURL command to request download links using the Fetch Download Links API. It demonstrates the necessary GET request, endpoint URL, and required headers including access key, project ID, job ID, sub-job ID, and load type.

```bash
curl --location --request GET 'https://abstract-dhudm.develgs.com/v1/udm/integrationapi/downloadLinks' \
--header 'accesskey: f1792c8c-84cb-444f-aff7-fc5e7b454ae6' \
--header 'projectId: 9e8c5a46-0e7f-4d8a-9031-81ffe69cf0d5' \
--header 'jobId: b81c4e20-3461-4c75-b603-8276472cac54' \
--header 'subJobId: d1e18354-efdf-4c51-a35d-cc40d164d8e5' \
--header 'loadType: COMPANY_AVATAR'
```

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

### Get Person API Endpoint Example

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Person_API/People_API_Documentation

This example demonstrates how to construct the GET request URL to retrieve a person's record along with their associated company and relationship details from the Gainsight API. It requires the domain and the email address of the person to be queried.

```http
GET https://personapi.gainsightcloud.com/v1/peoplemgmt/v1.0/people?Email=jsmith@abc.com
```

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

### Sample Data Retrieval

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Task_APIs

This section provides a sample response structure for data related to support gainsight, potentially including tasks and their details.

```APIDOC
## Sample Response Data Structure

### Description
This is a sample JSON response illustrating the structure of data that might be returned for support-related queries, such as task lists.

### Method
(Not applicable - This is a sample response structure)

### Endpoint
(Not applicable - This is a sample response structure)

### Parameters
(Not applicable - This is a sample response structure)

### Request Example
(Not applicable - This is a sample response structure)

### Response
#### Success Response (200)
- **result** (boolean) - Indicates if the operation was successful.
- **errorCode** (string) - Error code if the operation failed.
- **errorDesc** (string) - Description of the error if the operation failed.
- **requestId** (string) - Unique identifier for the request.
- **data** (array) - An array of data objects, potentially representing tasks or other records.
  - **ClosedDate** (string) - The date when the item was closed.
  - **CtaId__gr.Name** (string) - The name associated with the CTA ID.
  - **DueDate** (string) - The due date for the item.
  - **Gsid** (string) - The Gainsight ID of the item.
  - **IsClosed** (boolean) - Indicates if the item is closed.
  - **Name** (string) - The name of the item.
  - **OwnerId__gr.Name** (string) - The name of the owner.
  - **PriorityId__gr.Name** (string) - The name of the priority.
  - **StatusId__gr.Name** (string) - The name of the status.
  - **TypeId__gr.Name** (string) - The name of the type.
- **message** (string) - A message associated with the response.

#### Response Example
```json
{
  "result": true,
  "errorCode": null,
  "errorDesc": null,
  "requestId": "0eb5d905-9a0c-479e-b423-809eb0ded6bf",
  "data": [
      {
          "ClosedDate": "2020-05-21",
          "CtaId__gr.Name": "Ext. API 12.31",
          "DueDate": "2020-05-20",
          "Gsid": "1S032PUJRW05J6NDZ52CIIS4W30AE8L6G2TF",
          "IsClosed": true,
          "Name": "T2",
          "OwnerId__gr.Name": "Ankush Thakur",
          "PriorityId__gr.Name": "Medium",
          "StatusId__gr.Name": "Closed Success",
          "TypeId__gr.Name": "Task"
      },
      {
          "CtaId__gr.Name": "Ext. API 12.31",
          "DueDate": "2020-05-20",
          "Gsid": "1S032PUJRW05J6NDZ5LXU7O2V74YIBZOJQ9Y",
          "IsClosed": false,
          "Name": "T1",
          "OwnerId__gr.Name": "Ankush Thakur",
          "PriorityId__gr.Name": "Medium",
          "StatusId__gr.Name": "New",
          "TypeId__gr.Name": "Task"
      }
  ],
  "message": null
}
```
```

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

### Get API - categoryID Request Example

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Data_Management_APIs/Data_Management_APIs

This snippet shows a sample request for the 'Get API - categoryID' endpoint in Gainsight NXT. It demonstrates the URL structure for fetching dropdown data based on a category ID and includes a placeholder for an authentication token.

```http
GET /v1/meta/services/dropdowns/{categoryId}

Headers:
authToken: {authToken}
```

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

### SCIM Create User API Request Body Example (JSON)

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/User_Management_APIs/SCIM_API

This JSON payload demonstrates the structure for creating a new user via the SCIM API. It includes standard SCIM user attributes, enterprise extensions, and Gainsight-specific extensions for roles and license types. Ensure custom attributes are prefixed with the correct namespace and pre-configured in Gainsight.

```json
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
    "urn:ietf:params:scim:schemas:extension:gainsight:2.0:User"
  ],
  "userName": "sample1234",
  "name": {
    "givenName": "John",
    "familyName": "Dee"
  },
  "displayName": "John Dee",
  "emails": [
    {
      "primary": true,
      "value": "john@sample.com"
    }
  ],
  "groups": [
    {
      "value": "1UG1H0NQJHYL5UUYRUOVHAIVLE6T4RYOSI71",
      "display": "ITSpeciallist"
    },
    {
      "value": "1UG1H0NQJHYL5UUYRUHW61URSRJB05U836I2",
      "display": "Support"
    },
    {
      "value": "1UG1H0NQJHYL5UUYRUTDLYPRUDWA60SUXFD3",
      "display": "Services"
    }
  ], 
  "title": "Er",
  "active": true,
  "locale":"",
  "timezone":"",
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "manager": {
      "value": "1P01A7JNOWRLONI81IT5J6FZYM2IMLB72ZVL",
      "displayName": "Andy"
    }
  }, 
  "urn:ietf:params:scim:schemas:extension:gainsight:2.0:User": {
    "IsSuperAdmin": false,
    "custom_roles": [
      "JO Admin",
      "CSM"
    ],
    "LicenseType": "Full" 
  }
}
```

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

### Get API - categoryID Sample Request (HTTP)

Source: https://support.gainsight.com/gainsight_nxt/02Data_Management/Data_Management_API_Documentation/Data_Management_APIs

This shows a sample HTTP request for the Get API endpoint to retrieve dropdown data by category ID. It includes the base URL with the category ID placeholder and an example of an authorization token header.

```http
'{host}/v1/meta/services/dropdowns/{categoryId}'
'authToken: {authToken}'
```

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

### 多选Picklist过滤器操作符

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Call_To_Action_%28CTA%29_API_Documentation

这些是高级多选Picklist过滤器获取调用中支持的操作符。

```APIDOC
## Multi-Picklist Filters

These are some of the operators supported in advanced Multi-Picklist filters fetch calls:

### Includes

**Method**: Not specified

**Endpoint**: Not specified

**Parameters**:

#### Request Body

- **fieldName** (string) - Required - The name of the field to filter on.
- **value** (array of strings) - Required - The value(s) to compare against.
- **alias** (string) - Optional - An alias for the filter.
- **operator** (string) - Required - The operator to use, "INCLUDES" for Includes.

### Request Example

```json
{
  "fieldName": "ownerId__gr.user_multipicklist__gc",
  "value": ["1I0054U9FAKXZ0H26HF3ESSG4UYB5YTTPQVV", "1I0054U9FAKXZ0H26HTD7Y3TC7VE7MCN6BD0"],
  "alias": "A",
  "operator": "INCLUDES"
}
```

### Excludes

**Method**: Not specified

**Endpoint**: Not specified

**Parameters**:

#### Request Body

- **fieldName** (string) - Required - The name of the field to filter on.
- **value** (array of strings) - Required - The value(s) to compare against.
- **alias** (string) - Optional - An alias for the filter.
- **operator** (string) - Required - The operator to use, "EXCLUDES" for Excludes.

### Request Example

```json
{
  "fieldName": "ownerId__gr.user_multipicklist__gc",
  "value": ["1I0054U9FAKXZ0H26HTD7Y3TC7VE7MCN6BD0", "1I0054U9FAKXZ0H26HCDNCOD7NQT456P7RJL"],
  "alias": "A",
  "operator": "EXCLUDES"
}
```
```

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

### String Filters in Gainsight NXT

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Cockpit_API/Call_To_Action_%28CTA%29_API_Documentation

Provides examples of advanced string filter configurations in Gainsight NXT, supporting operators such as Equal, Not Equal, Starts With, Contains, Does Not Contain, Is Null, and Is Not Null.

```json
{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": ["Manufacturing process has started"],
  "alias": "A",
  "operator": "EQ"
}
```

```json
{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": ["Manufacturing process has started"],
  "alias": "A",
  "operator": "NE"
}
```

```json
{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": ["Manufacturing"],
  "alias": "A",
  "operator": "STARTS_WITH"
}
```

```json
{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": ["process"],
  "alias": "A",
  "operator": "CONTAINS"
}
```

```json
{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": ["process"],
  "alias": "A",
  "operator": "DOES_NOT_CONTAINS"
}
```

```json
{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NULL"
}
```

```json
{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NOT_NULL"
}
```

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

### Sample Gainsight NXT API Request (JSON)

Source: https://support.gainsight.com/gainsight_nxt/API_and_Developer_Docs/Success_Plan_APIs/Success_Plan_APIs

This JSON object represents a sample request to the Gainsight NXT API for creating or updating a success plan. It includes details about the record, associated objectives, and lookup configurations for user and company information. The 'allOrNone' flag indicates whether all operations must succeed or fail together.

```json
{
    "requests": [
        {
            "record": {
                "referenceId": "1",
                "Name": "Onboarding Success Plan",
                "SFDCID": "TZHYUJB8QBNHYUJIY",
                "OwnerEmail": "hsharma@gainsight.com",
                "DueDate": "2020-05-02",
                "SuccessPlanType": "Onboarding",
                "status": "Draft",
                "Templates": [
                    "Enterprise Template",
                    "Risk Template"
                ],
                "ActionPlan": "Support risk since too many tickets are open",
                "isEscalaed__gc": false,
                "Objectives": [
                    {
                        "Name": "Objective 1",
                        "DueDate": "2021-10-08",
                        "category": "Security Monitoring",
                        "maturityLevel__gc": "Level 1",
                        "Comments": "Ingestion of raw machine data,universal...",
                        "status": "Work in Progress 75%",
                        "priority": "High",
                        "playbook": "Dummy Playbook"
                    },
                    {
                        "Name": "Objective 2",
                        "DueDate": "2021-10-08",
                        "category": "Security Monitoring",
                        "maturityLevel__gc": "Level 1",
                        "Comments": "Ingestion of raw...",
                        "status": "Work in Progress 75%",
                        "priority": "High",
                        "playbook": "Dummy Playbook"
                    }
                ]
            },
            "lookups": {
                "OwnerId": {
                    "fields": {
                        "OwnerEmail": "Email"
                    },
                    "lookupField": "Gsid",
                    "objectName": "gsuser",
                    "multiMatchOption": "FIRSTMATCH",
                    "onNoMatch": "ERROR"
                },
                "CompanyId": {
                    "fields": {
                        "SFDCID": "sfdcid"
                    },
                    "lookupField": "Gsid",
                    "objectName": "company",
                    "multiMatchOption": "FIRSTMATCH",
                    "onNoMatch": "ERROR"
                }
            },
            "allOrNone": true
        }
    ]
}
```