Skip to main content
Gainsight Inc.

Data Management APIs

Gainsight NXT

 

The Data Management APIs are organized around REST (Representational State Transfer). This article explains to Admins the details of how these REST APIs can be used to get Gainsight Object and field details.

Introduction

Gainsight enables Admins to get Object and field metadata information using REST APIs. Not all teams who benefit from accessing Data Management always use Gainsight. They have systems of their choice and expect Gainsight to integrate better with them. Customers who have the development resources can use the APIs to build tighter and more customized integrations between Gainsight and other systems they use.

Business Use Case: When a customer wants to integrate their applications with Gainsight. They would want to understand how their data is going to be stored in Gainsight, that is the structure of metadata in a Gainsight Object. Such customers can use these APIs to get an understanding of the metadata of the Gainsight Object without logging into the Gainsight application.

Authentication

To use these Data Management APIs, ensure that you generate Access Token:

  • API Authentication: API access is controlled using a unique Access Key. Contact your Gainsight Admin to get an access key of the Gainsight tenant to which you want to send REST API requests. For more information on how to generate or share an access key, refer to the Generate API Access Key article.

Once you get the access key, you must pass the access key as part of the request header “accesskey” for all of your API requests into Gainsight. The Access Key does not expire.

Headers

Key Value
Access Key For more information on how to generate an access key, refer to the Authentication section.
Content Type JSON

Throttling Limits

The following are the recommended API limits for Gainsight APIs (The exact limits can vary based on your package):

  • Synchronous API Calls: 100 API calls per min / 50,000 API call per day
  • Asynchronous API Calls (Gainsight bulk APIs limit): 10 calls per hour / 100 per day

Note: All of the above API limits are *Fixed window rate limits.

* Fixed window rate limits restrict the number of API requests at a specific time. For example, a server can have a rate limiting component that implements a fixed window algorithm that only accepts 100 requests per minute. The time-frame is fixed, and it starts at a specific time. For example, the server will only serve 100 requests between 10:00 am, and 10:01 am.

API Rate Limit
Get Describe OMD 100 API calls per min / 50,000 API call per day
Post Describe OMD 100 API calls per min / 50,000 API call per day
Get Lite API Call OMD 100 API calls per min / 50,000 API call per day
Post Lite API Call OMD 100 API calls per min / 50,000 API call per day

Get Describe OMD

This API fetches the Object details and the related Object details such as ObjectName, label, objectType, labelPlural, and keyPrefix. It also fetches the following information about the Object’s fields:

  • Filterable
  • Sortable
  • Groupable
  • Createable
  • updateable
  • Formulafield
  • hasLookup
  • Required
  • Richtext
  • Nillable
  • Readonly
  • dependentPicklist
  • fieldGroupType
  • selfLookup
  • Indexed
  • decimalPlaces
  • Hidden
  • Namefield
  • Description
  • aggregatable

Method

GET

Endpoint URL

https://<customer-domain>/v1/meta/services/objects/<Objectname>/describe?ic=true&cl=3&idd=true

Sample Request

http://localhost:8080/v1/meta/services/objects/customobj__gc/describe?ic=true&cl=0&idd=true

For the namedFieldDetails in the describe response API, if the object has a lookup field and that lookup field has an attribute “isNamedField” : true, then namedFieldDetails will be added in lookupObjects.

Parameters

Parameters* Data Type Description
ic Boolean A Boolean flag that refers to include the children of the object being queried.
cl Number A Number flag that refers to the children level to which we need the response.
idd Boolean Boolean flag that defines whether the picklist details of the picklist fields are to be included in the response or not.
ihc Boolean Boolean flag that defines whether we should include hidden columns in the response or not.

Sample Success Response


{
   "requestId": "e5bf297f-1d17-44a8-a8e4-f65cbc1f758d",
   "result": true,
   "data": [
       {
           "objectName": "customobj__gc",
           "label": "customobj",
           "objectType": "CUSTOM",
           "labelPlural": "customobj",
           "keyPrefix": "1Z02W6JH35Q2P6CU2K",
           "fields": [
               {
                   "fieldName": "Name__gc",
                   "label": "Name",
                   "dataType": "STRING",
                   "objectName": "customobj__gc",
                   "meta": {
                       "properties": {
                           "sourceType": "STRING"
                       },
                       "filterable": true,
                       "sortable": true,
                       "groupable": true,
                       "createable": true,
                       "updateable": true,
                       "formulaField": false,
                       "hasLookup": false,
                       "required": false,
                       "richText": false,
                       "nillable": true,
                       "readOnly": false,
                       "dependentPicklist": false,
                       "fieldGroupType": "CUSTOM",
                       "selfLookup": false,
                       "indexed": false,
                       "decimalPlaces": 0,
                       "length": 500,
                       "hidden": false,
                       "nameField": false,
                       "aggregatable": true
                   }
               },
               {
                   "fieldName": "Gsid",
                   "label": "GSID",
                   "dataType": "GSID",
                   "objectName": "customobj__gc",
                   "meta": {
                       "properties": {
                           "sourceType": "GSID"
                       },
                       "filterable": true,
                       "sortable": true,
                       "groupable": true,
                       "createable": false,
                       "updateable": false,
                       "formulaField": false,
                       "hasLookup": false,
                       "required": false,
                       "richText": false,
                       "nillable": true,
                       "readOnly": true,
                       "dependentPicklist": false,
                       "fieldGroupType": "SYSTEM",
                       "selfLookup": false,
                       "indexed": true,
                       "decimalPlaces": 0,
                       "length": 220,
                       "hidden": false,
                       "nameField": false,
                       "description": "Gainsight ID",
                       "aggregatable": true
                   }
               },
               {
                   "fieldName": "CreatedDate",
                   "label": "GS Created Date",
                   "dataType": "DATETIME",
                   "objectName": "customobj__gc",
                   "meta": {
                       "properties": {
                           "sourceType": "DATETIME"
                       },
                       "filterable": true,
                       "sortable": true,
                       "groupable": true,
                       "createable": false,
                       "updateable": false,
                       "formulaField": false,
                       "hasLookup": false,
                       "required": false,
                       "richText": false,
                       "nillable": true,
                       "readOnly": true,
                       "dependentPicklist": false,
                       "fieldGroupType": "SYSTEM",
                       "selfLookup": false,
                       "indexed": true,
                       "decimalPlaces": 0,
                       "hidden": false,
                       "nameField": false,
                       "description": "Created Date",
                       "aggregatable": true
                   }
               },
               {
                   "fieldName": "ModifiedDate",
                   "label": "GS Modified Date",
                   "dataType": "DATETIME",
                   "objectName": "customobj__gc",
                   "meta": {
                       "properties": {
                           "sourceType": "DATETIME"
                       },
                       "filterable": true,
                       "sortable": true,
                       "groupable": true,
                       "createable": false,
                       "updateable": false,
                       "formulaField": false,
                       "hasLookup": false,
                       "required": false,
                       "richText": false,
                       "nillable": true,
                       "readOnly": true,
                       "dependentPicklist": false,
                       "fieldGroupType": "SYSTEM",
                       "selfLookup": false,
                       "indexed": true,
                       "decimalPlaces": 0,
                       "hidden": false,
                       "nameField": false,
                       "description": "Modified Date",
                       "aggregatable": true
                   }
               },
               {
                   "fieldName": "CreatedBy",
                   "label": "GS Created By",
                   "dataType": "LOOKUP",
                   "objectName": "customobj__gc",
                   "meta": {
                       "properties": {
                           "sourceType": "GSID",
                           "SEARCH_CONTROLLER": "AUTO_SUGGEST"
                       },
                       "filterable": true,
                       "sortable": true,
                       "groupable": true,
                       "createable": false,
                       "updateable": false,
                       "formulaField": false,
                       "hasLookup": true,
                       "required": false,
                       "richText": false,
                       "nillable": true,
                       "readOnly": true,
                       "dependentPicklist": false,
                       "fieldGroupType": "SYSTEM",
                       "selfLookup": false,
                       "indexed": true,
                       "decimalPlaces": 0,
                       "length": 220,
                       "lookupDetail": {
                           "lookupName": "CreatedBy__gr",
                           "fieldName": "Gsid",
                           "fieldDBName": "gsid",
                           "fieldLabel": "GSID",
                           "lookupId": "67905b63-dc89-4d7f-a82d-14eaa88bfd76",
                           "lookupObjects": [
                               {
                                   "id": "6e10a5d8-a38e-4807-97b2-3ccb75aa48ae",
                                   "objectName": "gsuser",
                                   "dbName": "user_ae9b9b672dd94dae948a87c2e13e35d6",
                                   "label": "User",
                                   "namedFieldDetails": {
                                       "hidden": false,
                                       "indexed": true,
                                       "unique": false,
                                       "format": null,
                                       "defaultValue": null,
                                       "primary": false,
                                       "distinctMemberCount": 0,
                                       "dimensionBrowserCollection": "SELF",
                                       "groupName": null,
                                       "measureValueBucket": null,
                                       "alignment": "LEFT",
                                       "aggFunction": "SUM",
                                       "numberType": "NUMBER",
                                       "decimalPlaces": 0,
                                       "thousandSeparatorUsed": false,
                                       "negativeNumber": "MINUSVALUE",
                                       "systemDefined": false,
                                       "encrypted": false,
                                       "deleted": false,
                                       "mappings": {
                                           "GAINSIGHT": {
                                               "key": "GS_USER_NAME",
                                               "keys": null,
                                               "dataType": "string",
                                               "format": null,
                                               "idField": null
                                           }
                                       },
                                       "source": null,
                                       "example": null,
                                       "maxLength": null,
                                       "options": null,
                                       "type": null,
                                       "properties": null,
                                       "collectionId": null,
                                       "calculatedExpression": null,
                                       "hasLookup": false,
                                       "lookupDetail": null,
                                       "gdmFormulaColumn": false,
                                       "gdmFreeFormEditor": false,
                                       "required": false,
                                       "editedColumn": false,
                                       "newColumn": false,
                                       "picklistItems": null,
                                       "currencyList": null,
                                       "operationType": null,
                                       "referenceOperation": null,
                                       "operations": null,
                                       "controllerField": null,
                                       "defaultStringValue": null,
                                       "name": "gsd88574",
                                       "DBName": "gsd88574",
                                       "datatype": "string",
                                       "complexType": null,
                                       "colattribtype": "DIMENSION",
                                       "DisplayName": "Name",
                                       "formula": null,
                                       "ColumnDescription": null,
                                       "FieldSchemaEditabilityType": "Fixed",
                                       "FieldDataEditabilityType": "All",
                                       "FieldGroupType": "STANDARD",
                                       "fieldName": "Name",
                                       "isSelfLookupField": false,
                                       "resolutionKeys": [],
                                       "isSearchable": false,
                                       "expression": null,
                                       "isReferenceField": false,
                                       "withTimeZone": false,
                                       "isTracked": false,
                                       "isCompressed": false,
                                       "isNamedField": true,
                                       "isPermissionAttribute": false,
                                       "isAdvancedFormula": false
                                   }
                               }
                           ]
                       },
                       "hidden": false,
                       "nameField": false,
                       "description": "GS Created By",
                       "aggregatable": true,
                       "onDeleteOperation": "None"
                   }
               },
               {
                   "fieldName": "ModifiedBy",
                   "label": "GS Modified By",
                   "dataType": "LOOKUP",
                   "objectName": "customobj__gc",
                   "meta": {
                       "properties": {
                           "sourceType": "GSID",
                           "SEARCH_CONTROLLER": "AUTO_SUGGEST"
                       },
                       "filterable": true,
                       "sortable": true,
                       "groupable": true,
                       "createable": false,
                       "updateable": false,
                       "formulaField": false,
                       "hasLookup": true,
                       "required": false,
                       "richText": false,
                       "nillable": true,
                       "readOnly": true,
                       "dependentPicklist": false,
                       "fieldGroupType": "SYSTEM",
                       "selfLookup": false,
                       "indexed": true,
                       "decimalPlaces": 0,
                       "length": 220,
                       "lookupDetail": {
                           "lookupName": "ModifiedBy__gr",
                           "fieldName": "Gsid",
                           "fieldDBName": "gsid",
                           "fieldLabel": "GSID",
                           "lookupId": "b0dcf8b2-1c7b-4767-ab63-b803d92305ec",
                           "lookupObjects": [
                               {
                                   "id": "6e10a5d8-a38e-4807-97b2-3ccb75aa48ae",
                                   "objectName": "gsuser",
                                   "dbName": "user_ae9b9b672dd94dae948a87c2e13e35d6",
                                   "label": "User",
                                   "namedFieldDetails": {
                                       "hidden": false,
                                       "indexed": true,
                                       "unique": false,
                                       "format": null,
                                       "defaultValue": null,
                                       "primary": false,
                                       "distinctMemberCount": 0,
                                       "dimensionBrowserCollection": "SELF",
                                       "groupName": null,
                                       "measureValueBucket": null,
                                       "alignment": "LEFT",
                                       "aggFunction": "SUM",
                                       "numberType": "NUMBER",
                                       "decimalPlaces": 0,
                                       "thousandSeparatorUsed": false,
                                       "negativeNumber": "MINUSVALUE",
                                       "systemDefined": false,
                                       "encrypted": false,
                                       "deleted": false,
                                       "mappings": {
                                           "GAINSIGHT": {
                                               "key": "GS_USER_NAME",
                                               "keys": null,
                                               "dataType": "string",
                                               "format": null,
                                               "idField": null
                                           }
                                       },
                                       "source": null,
                                       "example": null,
                                       "maxLength": null,
                                       "options": null,
                                       "type": null,
                                       "properties": null,
                                       "collectionId": null,
                                       "calculatedExpression": null,
                                       "hasLookup": false,
                                       "lookupDetail": null,
                                       "gdmFormulaColumn": false,
                                       "gdmFreeFormEditor": false,
                                       "required": false,
                                       "editedColumn": false,
                                       "newColumn": false,
                                       "picklistItems": null,
                                       "currencyList": null,
                                       "operationType": null,
                                       "referenceOperation": null,
                                       "operations": null,
                                       "controllerField": null,
                                       "defaultStringValue": null,
                                       "name": "gsd88574",
                                       "DBName": "gsd88574",
                                       "datatype": "string",
                                       "complexType": null,
                                       "colattribtype": "DIMENSION",
                                       "DisplayName": "Name",
                                       "formula": null,
                                       "ColumnDescription": null,
                                       "FieldSchemaEditabilityType": "Fixed",
                                       "FieldDataEditabilityType": "All",
                                       "FieldGroupType": "STANDARD",
                                       "fieldName": "Name",
                                       "isSelfLookupField": false,
                                       "resolutionKeys": [],
                                       "isSearchable": false,
                                       "expression": null,
                                       "isReferenceField": false,
                                       "withTimeZone": false,
                                       "isTracked": false,
                                       "isCompressed": false,
                                       "isNamedField": true,
                                       "isPermissionAttribute": false,
                                       "isAdvancedFormula": false
                                   }
                               }
                           ]
                       },
                       "hidden": false,
                       "nameField": false,
                       "description": "GS Modified By",
                       "aggregatable": true,
                       "onDeleteOperation": "None"
                   }
               }
           ],
           "transactional": true,
           "multiCurrencySupported": true,
           "readable": true,
           "createable": true,
           "schemaUpdateable": true,
           "description": "Custom object"
       }
   ]
}

Sample Failure Response


{
"requestId": "b698e142-fa4a-4c38-aa75-7d0cc34f3098",
"result": false,
"instance": "2021-02-03 10:31:28 UTC",
"title": "OBJECT_NOT_FOUND",
"detail": "Requested object not found.",
"errorDesc": "Requested object not found."
}

Post Describe OMD

This API is used to fetch the specific Objects detail and related Objects detail by filtering the response. You get Object details such as ObjectName, label, objectType, labelPlural, and keyPrefix. It also fetches the following information about the Object’s fields:

  • Filterable
  • Sortable
  • Groupable
  • Createable
  • updateable
  • Formulafield
  • hasLookup
  • Required
  • Richtext
  • Nillable
  • Readonly
  • dependentPicklist
  • fieldGroupType
  • selfLookup
  • Indexed
  • decimalPlaces
  • Hidden
  • Namefield
  • Description
  • aggregatable

Method

POST

Endpoint URL

https://<customer-domain>/v1/meta/services/objects/describe
http://localhost:8080/v1/meta/services/objects/describe

Sample Request


{
   "objectNames": [
       "customobj__gc"
   ],
   "includeChilds": "true",
   "childLevels": "0",
   "populatePickListOptions": "true",
   "useCollectionId": "false",
   "removeDeleted": "false",
   "removeHidden": "false",
   "host": "MDA",
   "sortFieldsByLabel": "true",
   "populateFieldId": "false",
   "honorUserContext": "true",
   "honorCustomLookup": "true",
   "populateAutoSuggestDetails": "true",
   "externalContext": "false"
}

Parameters

Parameters* Data Type Description
objectNames String A String that has a list of object names to be queried.
includeChilds Boolean A Boolean whether to include the child relationships of the objects in the query or not.
childLevels Number A Number to level down from the parent object that is queried.
removeHidden Boolean A Boolean field to remove the hidden field in the response.
includeDropDowns Boolean A Boolean flag that defines whether the picklist details of the picklist fields are to be included in the response.

Sample Success Response 


{
   "requestId": "154cc3d2-8f04-497a-8598-ea55781c47e8",
   "result": true,
   "data": [
       {
           "objectName": "customobj__gc",
           "label": "customobj",
           "objectType": "CUSTOM",
           "labelPlural": "customobj",
           "keyPrefix": "1Z02W6JH35Q2P6CU2K",
           "fields": [
               {
                   "fieldName": "Name__gc",
                   "label": "Name",
                   "dataType": "STRING",
                   "objectName": "customobj__gc",
                   "meta": {
                       "properties": {
                           "sourceType": "STRING"
                       },
                       "filterable": true,
                       "sortable": true,
                       "groupable": true,
                       "createable": true,
                       "updateable": true,
                       "formulaField": false,
                       "hasLookup": false,
                       "required": false,
                       "richText": false,
                       "nillable": true,
                       "readOnly": false,
                       "dependentPicklist": false,
                       "fieldGroupType": "CUSTOM",
                       "selfLookup": false,
                       "indexed": false,
                       "decimalPlaces": 0,
                       "length": 500,
                       "hidden": false,
                       "nameField": false,
                       "aggregatable": true
                   }
               },
               {
                   "fieldName": "Gsid",
                   "label": "GSID",
                   "dataType": "GSID",
                   "objectName": "customobj__gc",
                   "meta": {
                       "properties": {
                           "sourceType": "GSID"
                       },
                       "filterable": true,
                       "sortable": true,
                       "groupable": true,
                       "createable": false,
                       "updateable": false,
                       "formulaField": false,
                       "hasLookup": false,
                       "required": false,
                       "richText": false,
                       "nillable": true,
                       "readOnly": true,
                       "dependentPicklist": false,
                       "fieldGroupType": "SYSTEM",
                       "selfLookup": false,
                       "indexed": true,
                       "decimalPlaces": 0,
                       "length": 220,
                       "hidden": false,
                       "nameField": false,
                       "description": "Gainsight ID",
                       "aggregatable": true
                   }
               },
               {
                   "fieldName": "CreatedDate",
                   "label": "GS Created Date",
                   "dataType": "DATETIME",
                   "objectName": "customobj__gc",
                   "meta": {
                       "properties": {
                           "sourceType": "DATETIME"
                       },
                       "filterable": true,
                       "sortable": true,
                       "groupable": true,
                       "createable": false,
                       "updateable": false,
                       "formulaField": false,
                       "hasLookup": false,
                       "required": false,
                       "richText": false,
                       "nillable": true,
                       "readOnly": true,
                       "dependentPicklist": false,
                       "fieldGroupType": "SYSTEM",
                       "selfLookup": false,
                       "indexed": true,
                       "decimalPlaces": 0,
                       "hidden": false,
                       "nameField": false,
                       "description": "Created Date",
                       "aggregatable": true
                   }
               },
               {
                   "fieldName": "ModifiedDate",
                   "label": "GS Modified Date",
                   "dataType": "DATETIME",
                   "objectName": "customobj__gc",
                   "meta": {
                       "properties": {
                           "sourceType": "DATETIME"
                       },
                       "filterable": true,
                       "sortable": true,
                       "groupable": true,
                       "createable": false,
                       "updateable": false,
                       "formulaField": false,
                       "hasLookup": false,
                       "required": false,
                       "richText": false,
                       "nillable": true,
                       "readOnly": true,
                       "dependentPicklist": false,
                       "fieldGroupType": "SYSTEM",
                       "selfLookup": false,
                       "indexed": true,
                       "decimalPlaces": 0,
                       "hidden": false,
                       "nameField": false,
                       "description": "Modified Date",
                       "aggregatable": true
                   }
               },
               {
                   "fieldName": "CreatedBy",
                   "label": "GS Created By",
                   "dataType": "LOOKUP",
                   "objectName": "customobj__gc",
                   "meta": {
                       "properties": {
                           "autoSuggestDetails": {
                               "object": "gsuser",
                               "searchOn": [
                                   "Name",
                                   "Email"
                               ],
                               "dataStore": "HAPOSTGRES",
                               "columnsToList": [
                                   "Gsid"
                               ],
                               "connectionType": "MDA",
                               "connectionId": "MDA"
                           },
                           "sourceType": "GSID",
                           "SEARCH_CONTROLLER": "AUTO_SUGGEST"
                       },
                       "filterable": true,
                       "sortable": true,
                       "groupable": true,
                       "createable": false,
                       "updateable": false,
                       "formulaField": false,
                       "hasLookup": true,
                       "required": false,
                       "richText": false,
                       "nillable": true,
                       "readOnly": true,
                       "dependentPicklist": false,
                       "fieldGroupType": "SYSTEM",
                       "selfLookup": false,
                       "indexed": true,
                       "decimalPlaces": 0,
                       "length": 220,
                       "lookupDetail": {
                           "lookupName": "CreatedBy__gr",
                           "fieldName": "Gsid",
                           "fieldDBName": "gsid",
                           "fieldLabel": "GSID",
                           "lookupId": "67905b63-dc89-4d7f-a82d-14eaa88bfd76",
                           "lookupObjects": [
                               {
                                   "id": "6e10a5d8-a38e-4807-97b2-3ccb75aa48ae",
                                   "objectName": "gsuser",
                                   "dbName": "user_ae9b9b672dd94dae948a87c2e13e35d6",
                                   "label": "User",
                                   "namedFieldDetails": {
                                       "hidden": false,
                                       "indexed": true,
                                       "unique": false,
                                       "format": null,
                                       "defaultValue": null,
                                       "primary": false,
                                       "distinctMemberCount": 0,
                                       "dimensionBrowserCollection": "SELF",
                                       "groupName": null,
                                       "measureValueBucket": null,
                                       "alignment": "LEFT",
                                       "aggFunction": "SUM",
                                       "numberType": "NUMBER",
                                       "decimalPlaces": 0,
                                       "thousandSeparatorUsed": false,
                                       "negativeNumber": "MINUSVALUE",
                                       "systemDefined": false,
                                       "encrypted": false,
                                       "deleted": false,
                                       "mappings": {
                                           "GAINSIGHT": {
                                               "key": "GS_USER_NAME",
                                               "keys": null,
                                               "dataType": "string",
                                               "format": null,
                                               "idField": null
                                           }
                                       },
                                       "source": null,
                                       "example": null,
                                       "maxLength": null,
                                       "options": null,
                                       "type": null,
                                       "properties": null,
                                       "collectionId": null,
                                       "calculatedExpression": null,
                                       "hasLookup": false,
                                       "lookupDetail": null,
                                       "gdmFormulaColumn": false,
                                       "gdmFreeFormEditor": false,
                                       "required": false,
                                       "editedColumn": false,
                                       "newColumn": false,
                                       "picklistItems": null,
                                       "currencyList": null,
                                       "operationType": null,
                                       "referenceOperation": null,
                                       "operations": null,
                                       "controllerField": null,
                                       "defaultStringValue": null,
                                       "name": "gsd88574",
                                       "DBName": "gsd88574",
                                       "datatype": "string",
                                       "complexType": null,
                                       "colattribtype": "DIMENSION",
                                       "DisplayName": "Name",
                                       "formula": null,
                                       "ColumnDescription": null,
                                       "FieldSchemaEditabilityType": "Fixed",
                                       "FieldDataEditabilityType": "All",
                                       "FieldGroupType": "STANDARD",
                                       "fieldName": "Name",
                                       "isSelfLookupField": false,
                                       "resolutionKeys": [],
                                       "isSearchable": false,
                                       "expression": null,
                                       "isReferenceField": false,
                                       "withTimeZone": false,
                                       "isTracked": false,
                                       "isCompressed": false,
                                       "isNamedField": true,
                                       "isPermissionAttribute": false,
                                       "isAdvancedFormula": false
                                   }
                               }
                           ]
                       },
                       "hidden": false,
                       "nameField": false,
                       "description": "GS Created By",
                       "aggregatable": true,
                       "onDeleteOperation": "None"
                   }
               },
               {
                   "fieldName": "ModifiedBy",
                   "label": "GS Modified By",
                   "dataType": "LOOKUP",
                   "objectName": "customobj__gc",
                   "meta": {
                       "properties": {
                           "autoSuggestDetails": {
                               "object": "gsuser",
                               "searchOn": [
                                   "Name",
                                   "Email"
                               ],
                               "dataStore": "HAPOSTGRES",
                               "columnsToList": [
                                   "Gsid"
                               ],
                               "connectionType": "MDA",
                               "connectionId": "MDA"
                           },
                           "sourceType": "GSID",
                           "SEARCH_CONTROLLER": "AUTO_SUGGEST"
                       },
                       "filterable": true,
                       "sortable": true,
                       "groupable": true,
                       "createable": false,
                       "updateable": false,
                       "formulaField": false,
                       "hasLookup": true,
                       "required": false,
                       "richText": false,
                       "nillable": true,
                       "readOnly": true,
                       "dependentPicklist": false,
                       "fieldGroupType": "SYSTEM",
                       "selfLookup": false,
                       "indexed": true,
                       "decimalPlaces": 0,
                       "length": 220,
                       "lookupDetail": {
                           "lookupName": "ModifiedBy__gr",
                           "fieldName": "Gsid",
                           "fieldDBName": "gsid",
                           "fieldLabel": "GSID",
                           "lookupId": "b0dcf8b2-1c7b-4767-ab63-b803d92305ec",
                           "lookupObjects": [
                               {
                                   "id": "6e10a5d8-a38e-4807-97b2-3ccb75aa48ae",
                                   "objectName": "gsuser",
                                   "dbName": "user_ae9b9b672dd94dae948a87c2e13e35d6",
                                   "label": "User",
                                   "namedFieldDetails": {
                                       "hidden": false,
                                       "indexed": true,
                                       "unique": false,
                                       "format": null,
                                       "defaultValue": null,
                                       "primary": false,
                                       "distinctMemberCount": 0,
                                       "dimensionBrowserCollection": "SELF",
                                       "groupName": null,
                                       "measureValueBucket": null,
                                       "alignment": "LEFT",
                                       "aggFunction": "SUM",
                                       "numberType": "NUMBER",
                                       "decimalPlaces": 0,
                                       "thousandSeparatorUsed": false,
                                       "negativeNumber": "MINUSVALUE",
                                       "systemDefined": false,
                                       "encrypted": false,
                                       "deleted": false,
                                       "mappings": {
                                           "GAINSIGHT": {
                                               "key": "GS_USER_NAME",
                                               "keys": null,
                                               "dataType": "string",
                                               "format": null,
                                               "idField": null
                                           }
                                       },
                                       "source": null,
                                       "example": null,
                                       "maxLength": null,
                                       "options": null,
                                       "type": null,
                                       "properties": null,
                                       "collectionId": null,
                                       "calculatedExpression": null,
                                       "hasLookup": false,
                                       "lookupDetail": null,
                                       "gdmFormulaColumn": false,
                                       "gdmFreeFormEditor": false,
                                       "required": false,
                                       "editedColumn": false,
                                       "newColumn": false,
                                       "picklistItems": null,
                                       "currencyList": null,
                                       "operationType": null,
                                       "referenceOperation": null,
                                       "operations": null,
                                       "controllerField": null,
                                       "defaultStringValue": null,
                                       "name": "gsd88574",
                                       "DBName": "gsd88574",
                                       "datatype": "string",
                                       "complexType": null,
                                       "colattribtype": "DIMENSION",
                                       "DisplayName": "Name",
                                       "formula": null,
                                       "ColumnDescription": null,
                                       "FieldSchemaEditabilityType": "Fixed",
                                       "FieldDataEditabilityType": "All",
                                       "FieldGroupType": "STANDARD",
                                       "fieldName": "Name",
                                       "isSelfLookupField": false,
                                       "resolutionKeys": [],
                                       "isSearchable": false,
                                       "expression": null,
                                       "isReferenceField": false,
                                       "withTimeZone": false,
                                       "isTracked": false,
                                       "isCompressed": false,
                                       "isNamedField": true,
                                       "isPermissionAttribute": false,
                                       "isAdvancedFormula": false
                                   }
                               }
                           ]
                       },
                       "hidden": false,
                       "nameField": false,
                       "description": "GS Modified By",
                       "aggregatable": true,
                       "onDeleteOperation": "None"
                   }
               }
           ],
           "transactional": true,
           "multiCurrencySupported": true,
           "readable": true,
           "createable": true,
           "schemaUpdateable": true,
           "description": "Custom object"
       }
   ]
}

Sample Failure Response

{
"requestId": "b698e142-fa4a-4c38-aa75-7d0cc34f3098",
"result": false,
"instance": "2021-02-03 10:31:28 UTC",
"title": "OBJECT_NOT_FOUND",
"detail": "Requested object not found.",
"errorDesc": "Requested object not found."
} 

Get Lite API Call OMD

This API is used to fetch the list of Objects with the minimum metadata information such as:

  • objectName
  • Label
  • objectType
  • keyPrefix
  • Transactional
  • multiCurrencySupported
  • Readable
  • Createable
  • schemaUpdateable

Method

GET

Endpoint URL

https://<customer-domain>/v1/meta/services/objects/list?po=company&em=false

Sample Request

https://<customer-domain>/v1/meta/services/objects/list?po=company&em=false

Parameters

Parameters* Data Type Description
po String A String value that stands for parent object marker.
em Boolean A Boolean field that determines whether to exclude related objects in response or not.

Sample Success Response

{
"requestId": "7ac6a2e6-85ac-44df-958a-ee4b00384436",
"result": true,
"data": [
     {
         "objectName": "autoindex10__gc",
         "label": "AutoIndex10",
         "objectType": "CUSTOM",
         "keyPrefix": "1Z02KRI7NHRRVF6ZWJ",
         "transactional": true,
         "multiCurrencySupported": false,
         "readable": true,
         "createable": true,
         "schemaUpdateable": true
     },
     {
         "objectName": "company",
         "label": "Company",
         "objectType": "STANDARD",
         "keyPrefix": "1P02C503CKNHR9B14K",
         "transactional": false,
         "multiCurrencySupported": false,
         "readable": true,
         "createable": true,
         "schemaUpdateable": true
     },
     {
         "objectName": "company_person",
         "label": "Company Person",
         "objectType": "STANDARD",
         "keyPrefix": "1C01TEHFH1FP2KG5WQ",
         "transactional": false,
         "multiCurrencySupported": false,
         "readable": true,
         "createable": true,
         "schemaUpdateable": true
     },
     {
         "objectName": "email_logs",
         "label": "Email Logs",
         "objectType": "STANDARD",
         "transactional": false,
         "multiCurrencySupported": false,
         "readable": true,
         "createable": true,
         "schemaUpdateable": true
     },
     {
         "objectName": "email_raw_events",
         "label": "Email Raw Events",
         "objectType": "SYSTEM",
         "transactional": false,
         "multiCurrencySupported": false,
         "readable": true,
         "createable": false,
         "schemaUpdateable": false
     },
     {
         "objectName": "obj1__gc",
         "label": "Obj1",
         "objectType": "CUSTOM",
         "keyPrefix": "1Z024OYZBEOENYQ9RH",
         "transactional": true,
         "multiCurrencySupported": false,
         "readable": true,
         "createable": true,
         "schemaUpdateable": true
     },
     {
         "objectName": "relationship",
         "label": "Relationship",
         "objectType": "STANDARD",
         "keyPrefix": "1P05VX75GX1CCNZ59W",
         "transactional": false,
         "multiCurrencySupported": false,
         "readable": true,
         "createable": true,
         "schemaUpdateable": true
     },
     {
         "objectName": "relationship_person",
         "label": "Relationship Person",
         "objectType": "STANDARD",
         "keyPrefix": "1C03FQDZ4TJLWHYROF",
         "transactional": false,
         "multiCurrencySupported": false,
         "readable": true,
         "createable": true,
         "schemaUpdateable": true
     },
     {
         "objectName": "sponsor_tracking",
         "label": "Sponsor Tracking",
         "objectType": "STANDARD",
         "keyPrefix": "1S075PAB66AVNGO818Y",
         "transactional": false,
         "multiCurrencySupported": false,
         "readable": true,
         "createable": false,
         "schemaUpdateable": true
     },
     {
         "objectName": "gsuser",
         "label": "User",
         "objectType": "STANDARD",
         "keyPrefix": "1P01N68IASVWNJD6IE",
         "transactional": false,
         "multiCurrencySupported": false,
         "readable": true,
         "createable": true,
         "schemaUpdateable": true
     },
     {
         "objectName": "user_shared_detail",
         "label": "User Shared Detail",
         "objectType": "STANDARD",
         "keyPrefix": "P02",
         "transactional": false,
         "multiCurrencySupported": false,
         "readable": true,
         "createable": false,
         "schemaUpdateable": true
     }
]
}

Sample Failure Response

{
"requestId": "7007e23f-e5c7-4381-995a-86cba5635c19",
"result": false,
"instance": "2021-02-03 10:32:50 UTC",
"title": "PARENT_OBJECT_NOT_FOUND",
"detail": "Parent Object Not Found or Invalid Object",
"errorDesc": "Parent Object Not Found or Invalid Object"
} 

Post Lite API Call OMD

This API is used to fetch the specific list of Objects with the minimum metadata information by filtering the required Objects. It gets Object details such as:

  • objectName
  • label
  • objectType
  • keyPrefix
  • Transactional
  • multiCurrencySupported
  • Readable
  • Createable
  • schemaUpdateable

Method

POST

Endpoint URL

https://<customer-domain>/v1/meta/services/objects/

Sample Request

{
    "externalUse":"true",
    "parentObject":"company",
    "excludeMappings":"false",
    "sortByLabel":"false"
}

Sample Success Response

{
    "requestId": "ec934e17-5420-4221-80fc-97655e8e750b",
    "result": true,
    "data": [
        {
            "objectName": "anonymous_person",
            "label": "Anonymous Person",
            "objectType": "STANDARD",
            "keyPrefix": "1C02M7XRJCBG6QI6SV",
            "transactional": false,
            "multiCurrencySupported": false,
            "readable": true,
            "createable": true,
            "schemaUpdateable": true
        },
        {
            "objectName": "user_shared_detail",
            "label": "User Shared Detail",
            "objectType": "STANDARD",
            "keyPrefix": "P02",
            "transactional": false,
            "multiCurrencySupported": false,
            "readable": true,
            "createable": false,
            "schemaUpdateable": true
        }
    ]
} 

Sample Failure Response

{
"requestId": "7007e23f-e5c7-4381-995a-86cba5635c19",
"result": false,
"instance": "2021-02-03 10:32:50 UTC",
"title": "PARENT_OBJECT_NOT_FOUND",
"detail": "Parent Object Not Found or Invalid Object",
"errorDesc": "Parent Object Not Found or Invalid Object"
}

Get API - categoryID

Method

GET

Endpoint URL

/v1/meta/services/dropdowns/{categoryId}

Sample Request


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

Sample Response


{
    "requestId": "30c9352a-b996-472a-a662-3e09fbf0fad6",
    "result": true,
    "data": {
        "categoryDetails": {
            "createdAt": 1677922074238,
            "deleted": false,
            "modifiedAt": 1677922074238,
            "name": "LicenseType",
            "description": "LicenseType",
            "type": "SYSTEM",
            "count": 5,
            "limit": 500,
            "variant": "SINGLE_SELECT",
            "systemName": "LicenseType",
            "gsid": "1I00K3A4X4T2UWD3COJ3FU0KMKYXZL9WEEFK"
        },
        "childItems": [
            {
                "createdAt": 1677922074249,
                "deleted": false,
                "modifiedAt": 1677922074249,
                "name": "Viewer",
                "description": "Viewer License",
                "displayOrder": 1,
                "shortName": null,
                "color": null,
                "active": true,
                "systemDefined": true,
                "systemName": "Viewer",
                "default": false,
                "categoryId": "1I00K3A4X4T2UWD3COJ3FU0KMKYXZL9WEEFK",
                "gsid": "1I00AABNSR5CLLWSP3IK3IVPS8983FQVHJ2H"
            },
            {
                "createdAt": 1677922074249,
                "deleted": false,
                "modifiedAt": 1677922074249,
                "name": "Full",
                "description": "Full License",
                "displayOrder": 2,
                "shortName": null,
                "color": null,
                "active": true,
                "systemDefined": true,
                "systemName": "Full",
                "default": false,
                "categoryId": "1I00K3A4X4T2UWD3COJ3FU0KMKYXZL9WEEFK",
                "gsid": "1I00AABNSR5CLLWSP3WTEJAI22CWWL8D6YQ8"
            },
            {
                "createdAt": 1677922074249,
                "deleted": false,
                "modifiedAt": 1677922074249,
                "name": "External",
                "description": "External",
                "displayOrder": 3,
                "shortName": null,
                "color": null,
                "active": true,
                "systemDefined": true,
                "systemName": "External",
                "default": false,
                "categoryId": "1I00K3A4X4T2UWD3COJ3FU0KMKYXZL9WEEFK",
                "gsid": "1I00AABNSR5CLLWSP3F09ND6JHASXGUW8BW4"
            },
            {
                "createdAt": 1677922074249,
                "deleted": false,
                "modifiedAt": 1677922074249,
                "name": "Internal_Collaborator",
                "description": "Internal Collaborator",
                "displayOrder": 4,
                "shortName": null,
                "color": null,
                "active": true,
                "systemDefined": true,
                "systemName": "Internal_Collaborator",
                "default": false,
                "categoryId": "1I00K3A4X4T2UWD3COJ3FU0KMKYXZL9WEEFK",
                "gsid": "1I00AABNSR5CLLWSP3SDI6N47DFH0XM4BMT4"
            },
            {
                "createdAt": 1677922074249,
                "deleted": false,
                "modifiedAt": 1677922074249,
                "name": "Viewer_Analytics",
                "description": "Viewer Analytics",
                "displayOrder": 5,
                "shortName": null,
                "color": null,
                "active": true,
                "systemDefined": true,
                "systemName": "Viewer_Analytics",
                "default": false,
                "categoryId": "1I00K3A4X4T2UWD3COJ3FU0KMKYXZL9WEEFK",
                "gsid": "1I00AABNSR5CLLWSP3XP4Z60275S4B1TCIJM"
            }
        ]
    }
}

Sample Failure Response


{
    "result": false,
    "errorCode": "GS_APIG_2401",
    "errorDesc": "Unauthorized",
    "requestId": "0a719c1a-2705-4a3e-82ba-aa14beeba64e",
    "message": "Unauthorized"
}

Post API - Dependencies

Method

POST

Endpoint URL

/v1/meta/services/dropdowns/dependencies

Sample Request


'{host}/v1/meta/services/dropdowns/dependencies'
'authToken: {authToken}'
'Content-Type: text/plain'
'{"limit":25,"pageNo":1,"searchString":""}'

Sample Response


{
    "requestId": "4181a24f-649c-4d86-919f-e49ed1d9275c",
    "result": true,
    "data": {
        "dependencyMappings": [
            {
                "dependentCategory": {
                    "createdAt": 1678181069951,
                    "deleted": false,
                    "modifiedAt": 1681378690565,
                    "name": "single12",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 4,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I00CX13WW9TZO4F07DVQ3PTCC9J6NN1MUEY"
                },
                "controllerCategory": {
                    "createdAt": 1678181127428,
                    "deleted": false,
                    "modifiedAt": 1678181127428,
                    "name": "multi",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 7,
                    "limit": 500,
                    "variant": "MULTI_SELECT",
                    "systemName": null,
                    "gsid": "1I00GY1A5C0DZBNCOZXD5WC5XB1NYX1TQ5XW"
                }
            },
            {
                "dependentCategory": {
                    "createdAt": 1682768826459,
                    "deleted": false,
                    "modifiedAt": 1682768826459,
                    "name": "AprilRT Single",
                    "description": "AprilRT Single",
                    "type": "CUSTOM",
                    "count": 3,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I00UDCAO988OBNYYFNLDG5UOLMWHHHOC79C"
                },
                "controllerCategory": {
                    "createdAt": 1682768853425,
                    "deleted": false,
                    "modifiedAt": 1682768853425,
                    "name": "April Multi RT",
                    "description": "April Multi RT",
                    "type": "CUSTOM",
                    "count": 3,
                    "limit": 500,
                    "variant": "MULTI_SELECT",
                    "systemName": null,
                    "gsid": "1I0098BLUJJMXBAMP0GWY82014F5EAVLA3TW"
                }
            },
            {
                "dependentCategory": {
                    "createdAt": 1682929200132,
                    "deleted": false,
                    "modifiedAt": 1682929200132,
                    "name": "state",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 4,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I008ZIUYRF52Z11S7AWENNRFTO3H0I2XJAL"
                },
                "controllerCategory": {
                    "createdAt": 1682929172453,
                    "deleted": false,
                    "modifiedAt": 1682929172453,
                    "name": "Country",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 2,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I00ARND7FWBTLW14JKZYFD2BWYUQADEJ4B1"
                }
            },
            {
                "dependentCategory": {
                    "createdAt": 1686048581381,
                    "deleted": false,
                    "modifiedAt": 1686048581381,
                    "name": "SingleSelectPicklistTwo",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 4,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I00QFSLDGXG0BETER6Y6XMVKQ7UX81PQ85J"
                },
                "controllerCategory": {
                    "createdAt": 1686048552663,
                    "deleted": false,
                    "modifiedAt": 1686048552663,
                    "name": "SingleSelectPicklistOne",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 4,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I00P3GX7I72MLWVSV5HX0C19IM1QSS5F8P4"
                }
            },
            {
                "dependentCategory": {
                    "createdAt": 1678160920801,
                    "deleted": false,
                    "modifiedAt": 1678160920801,
                    "name": "MultiSelectDropDown",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 8,
                    "limit": 500,
                    "variant": "MULTI_SELECT",
                    "systemName": null,
                    "gsid": "1I00EU7Q9RP79QAIN6XIQIKCC4QJLS30SQ3W"
                },
                "controllerCategory": {
                    "createdAt": 1678160891956,
                    "deleted": false,
                    "modifiedAt": 1678160891956,
                    "name": "SingleSelectDropDown",
                    "description": "Testing",
                    "type": "CUSTOM",
                    "count": 4,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I00EZBVXJMJGT8995568824CQOXHM5RMGSX"
                }
            },
            {
                "dependentCategory": {
                    "createdAt": 1677922074029,
                    "deleted": false,
                    "modifiedAt": 1677922074029,
                    "name": "Person Relationship Value",
                    "description": "Person Relationship Value",
                    "type": "SYSTEM",
                    "count": 3,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": "Person Relationship Value",
                    "gsid": "1I00XEEYIYGWPK4FH4TITLUDT8R1BJ0UZSHQ"
                },
                "controllerCategory": {
                    "createdAt": 1677922074006,
                    "deleted": false,
                    "modifiedAt": 1677922074006,
                    "name": "Person Relationship Type",
                    "description": "Person Relationship Type",
                    "type": "SYSTEM",
                    "count": 1,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": "Person Relationship Type",
                    "gsid": "1I00E8F6VDZ74PR03PJGGMXAIB4CLH39MAW3"
                }
            },
            {
                "dependentCategory": {
                    "createdAt": 1693387126052,
                    "deleted": false,
                    "modifiedAt": 1693387126052,
                    "name": "Hotfix Pick 2",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 5,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I004U9ND4O9DEJ09JOV8O91EKS4THM785JR"
                },
                "controllerCategory": {
                    "createdAt": 1693387101991,
                    "deleted": false,
                    "modifiedAt": 1693387101991,
                    "name": "Hotfix Pick 1",
                    "description": "Hotfix Pick 1",
                    "type": "CUSTOM",
                    "count": 3,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I00MCO4VWTL1IB4ORGRUARL8TVBVS31M5X4"
                }
            },
            {
                "dependentCategory": {
                    "createdAt": 1693387148394,
                    "deleted": false,
                    "modifiedAt": 1693387148394,
                    "name": "Hotfix Pick 3",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 5,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I00H362PNT54IUUJY57S5Z1P7QPH0DVKE47"
                },
                "controllerCategory": {
                    "createdAt": 1693387126052,
                    "deleted": false,
                    "modifiedAt": 1693387126052,
                    "name": "Hotfix Pick 2",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 5,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I004U9ND4O9DEJ09JOV8O91EKS4THM785JR"
                }
            },
            {
                "dependentCategory": {
                    "createdAt": 1693387148394,
                    "deleted": false,
                    "modifiedAt": 1693387148394,
                    "name": "Hotfix Pick 3",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 5,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I00H362PNT54IUUJY57S5Z1P7QPH0DVKE47"
                },
                "controllerCategory": {
                    "createdAt": 1693387101991,
                    "deleted": false,
                    "modifiedAt": 1693387101991,
                    "name": "Hotfix Pick 1",
                    "description": "Hotfix Pick 1",
                    "type": "CUSTOM",
                    "count": 3,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I00MCO4VWTL1IB4ORGRUARL8TVBVS31M5X4"
                }
            },
            {
                "dependentCategory": {
                    "createdAt": 1693387189198,
                    "deleted": false,
                    "modifiedAt": 1693387189198,
                    "name": "Multi 2",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 5,
                    "limit": 500,
                    "variant": "MULTI_SELECT",
                    "systemName": null,
                    "gsid": "1I004JS2B57VUWT7WD3HTZWWRTW9430XT3ZS"
                },
                "controllerCategory": {
                    "createdAt": 1693387165295,
                    "deleted": false,
                    "modifiedAt": 1693387165295,
                    "name": "Multi 1",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 3,
                    "limit": 500,
                    "variant": "MULTI_SELECT",
                    "systemName": null,
                    "gsid": "1I006WUOEH2630IX6GU5SUW6DBFN6S8FCM3A"
                }
            },
            {
                "dependentCategory": {
                    "createdAt": 1693387216810,
                    "deleted": false,
                    "modifiedAt": 1693387216810,
                    "name": "Multi 3",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 5,
                    "limit": 500,
                    "variant": "MULTI_SELECT",
                    "systemName": null,
                    "gsid": "1I00CHUZHEBKF6EWWKQQFBP44HW8E43GGCUG"
                },
                "controllerCategory": {
                    "createdAt": 1693387189198,
                    "deleted": false,
                    "modifiedAt": 1693387189198,
                    "name": "Multi 2",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 5,
                    "limit": 500,
                    "variant": "MULTI_SELECT",
                    "systemName": null,
                    "gsid": "1I004JS2B57VUWT7WD3HTZWWRTW9430XT3ZS"
                }
            },
            {
                "dependentCategory": {
                    "createdAt": 1693387101991,
                    "deleted": false,
                    "modifiedAt": 1693387101991,
                    "name": "Hotfix Pick 1",
                    "description": "Hotfix Pick 1",
                    "type": "CUSTOM",
                    "count": 3,
                    "limit": 500,
                    "variant": "SINGLE_SELECT",
                    "systemName": null,
                    "gsid": "1I00MCO4VWTL1IB4ORGRUARL8TVBVS31M5X4"
                },
                "controllerCategory": {
                    "createdAt": 1693387165295,
                    "deleted": false,
                    "modifiedAt": 1693387165295,
                    "name": "Multi 1",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 3,
                    "limit": 500,
                    "variant": "MULTI_SELECT",
                    "systemName": null,
                    "gsid": "1I006WUOEH2630IX6GU5SUW6DBFN6S8FCM3A"
                }
            },
            {
                "dependentCategory": {
                    "createdAt": 1694419141658,
                    "deleted": false,
                    "modifiedAt": 1694419141658,
                    "name": "Test Drop 2",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 4,
                    "limit": 500,
                    "variant": "MULTI_SELECT",
                    "systemName": null,
                    "gsid": "1I00259PT8C6XOA5TC6V6Q3OOVXQTA2QHCAD"
                },
                "controllerCategory": {
                    "createdAt": 1694419119972,
                    "deleted": false,
                    "modifiedAt": 1694419119972,
                    "name": "TestDrop1",
                    "description": "",
                    "type": "CUSTOM",
                    "count": 3,
                    "limit": 500,
                    "variant": "MULTI_SELECT",
                    "systemName": null,
                    "gsid": "1I009JV5WHN0WUPEM5RFBHVVI4I8LVENZFXY"
                }
            }
        ],
        "nextPage": -1,
        "nextSize": -1,
        "totalSize": 13
    }
}

Sample Failure Response


{
    "result": false,
    "errorCode": "GS_APIG_2401",
    "errorDesc": "Unauthorized",
    "requestId": "0a719c1a-2705-4a3e-82ba-aa14beeba64e",
    "message": "Unauthorized"
}
  • Was this article helpful?