アドプションエクスプローラーAPI

最後の更新
PDFとして保存

重要 - 画像/情報は四半期ごとのリリースで更新されます!

四半期ごとのリリースにて、最新の機能・情報を反映し、画像を含めた情報は更新されます。

アドプションエクスプローラー (AE) APIは、REST (Representational State Transfer) を中心に構成されています。この記事では管理者に、これらのREST APIを使用してAEプロジェクトの実行ステータスを取得する方法を説明します。

概要

アドプションエクスプローラーを使用すると、管理者はGainsight環境下での顧客のデータ使用状況に基づいてプロジェクトを構築できます。AE REST APIを使用することにより、管理者は外部システムからAEプロジェクトのログにアクセスして状況を確認できます。一部の顧客、特にセキュリティビジネスの顧客にとって、これは非常に重要になります。

これらのAPIを使用することにより、管理者はプロジェクトログの詳細をジョブおよびサブジョブレベルまで取得できます。管理者は、ジョブ、サブジョブのデータ処理/ロード情報や、csvリンクを使ってカンパニーデータレゾリューションの詳細を取得できます。

ビジネスユースケースの例：AEにアクセスして恩恵を受けるすべてのチームが、Gainsightを常に使用しているわけではありません。そのような顧客は、彼らが選択したシステムとGainsightのより優れた統合を期待しています。このようなシナリオでは、AE APIを使用することにより、顧客は外部システムからAEにアクセスして、そのジョブステータスを確認できます。顧客が開発リソースを持っている場合は、これらのAPIを使用して、Gainsightと彼らが使用する他のシステムとの間のより緊密でカスタマイズされた統合を構築することができます。

アドプションエクスプローラーでプロジェクトを手動でスケジュール/実行する方法に関しては、追加リソースセクションのログ記事を参照してください。

前提条件

AE APIを使用するには、アクセストークンを生成する必要があります。

APIの認証：APIへのアクセスは、固有のアクセスキーを使用して制御されます。REST API要求を送信するGainsightテナントのアクセスキーを取得するにはGainsight 管理者に連絡してください。アクセスキーを生成または共有する方法の詳細については、「その他のリソース」セクションのAPIアクセスキーの生成に関する記事を参照してください。

アクセスキーを取得したら、すべてのAPIリクエストのリクエストヘッダー「accesskey」の一部としてアクセスキーをGainsightに渡します。アクセスキーに有効期限はありません。

プロジェクトの詳細を取得

プロジェクトの詳細を取得 APIを使用すると、projectNameまたは projectIdでプロジェクトの詳細を取得できます。projectNameまたは projectIdは必要ですが、両方の詳細を入力すると、projectNameが使用できます。

このAPIは、プロジェクトの次のフィールドを取得します。

ProjectId
プロジェクト名
状態
名前で作成
名前で変更

方法の詳細

APIの詳細	説明
エンドポイントのURL	<apiGatewayURL>/v1/udm/integrationapi/projectDetails
リクエスト方法	GET
ヘッダー	アクセスキー：<GainsightAPI accessKey> projectName: <projectName> projectId: <projectId> optionalResponseParams: companyEnabledDetails,personEnabledDetails,secondaryCompanyExist,additionalDetails

APIの詳細

説明

エンドポイントのURL

<apiGatewayURL>/v1/udm/integrationapi/projectDetails

リクエスト方法

GET

ヘッダー

アクセスキー：<GainsightAPI accessKey>

projectName: <projectName>

projectId: <projectId>

optionalResponseParams: companyEnabledDetails,personEnabledDetails,secondaryCompanyExist,additionalDetails

メモ: より簡潔な応答を取得するには、定義済みの optionalResponseParamsをコンマで区切って入力します。

リクエストのサンプル

以下は、プロジェクトの詳細を取得 APIに対するリクエストの例です。

curl --location --request GET 'https://abstract-dhudm.develgs.com/v1/udm/integrationapi/projectDetails' \
--header 'projectName: Horizon UI Do Not touch' \
--header 'accesskey: f1792c8c-84cb-444f-aff7-fc5e7b454ae6' \--header 'optionalResponseParams;' \

応答成功のサンプル

以下は、プロジェクトの詳細を取得 APIに対する応答成功の例です。

{
    "result": true,
    "requestId": "4b72749f-2b1f-4fa5-be62-0b8e175b60b7",
    "data": {
        "id": 732,
        "projectId": "9e8c5a46-0e7f-4d8a-9031-81ffe69cf0d5",
        "name": "Horizon UI Do Not touch",
        "status": "ACTIVE",
        "createdByName": "Arvind Singh",
        "modifiedByName": "Arvind Singh"
    }
}

応答失敗のサンプル

以下は、プロジェクトの詳細を取得APIに対する応答失敗の例です。

{
    "result": false,
    "errorCode": "2003",
    "errorDesc": "Bad Request, please check your input.",
    "requestId": "30e7d770-a58b-4290-86c7-ba8bc53a4c3c",
    "message": "Bad Request, please check your input.",
    "messages": [
        "Project not available, its either deleted or never created, please contact tech support!!!"
    ]
}

ジョブ詳細の取得

フェッチジョブの詳細 APIを使用すると、AEプロジェクトのジョブ詳細をプロジェクトIDで取得できます。projectIdが分からない場合は、プロジェクトの詳細を取得APIを呼び出して詳細を取得できます。詳細については、この記事の「プロジェクトの詳細を取得」セクションを参照してください。

このAPIは、適用されるペイロード条件に応じて、次のジョブ詳細を取得します:

作成者
最終更新日
テナントID
ジョブID
ジョブステータス
スケジュール頻度
実行日
タイプ
開始時間
タイプ

ペイロード条件の詳細については、この記事の「ペイロード条件」セクションを参照してください。

方法の詳細

APIの詳細	説明
エンドポイントのURL	<apiGatewayURL>/v1/udm/integrationapi/jobDetails
リクエスト方法	ポスト
ヘッダー	アクセスキー：<GainsightAPI accessKey> projectId: <projectId> optionalResponseParams: udmJobId,dpPrimaryJobId
クエリパラメータ	制限：30 オフセット：0 order_by: modified_at 降順：真

メモ: すべてのクエリパラメータはオプションであり、指定された場合にのみ考慮されます。

ペイロード条件 [オプション]

ペイロードはオプションであり、入力された場合はそれに対応したフィルターが構築され、結果が返されます。

サポートされているフィルターフィールド: job_status、run_for_date、start_time、modified_at、schedule_frequency、type.

サポートされている演算子：EQ、NE、IS_NULL、IS_NOT_NULL、LT、GT、LTE、GTE (一部の演算子は日付フィールドでのみ有効)。

サポートされている値：

job_status - ABORTED, FAILED, PARTIAL_SUCCESS, STARTED, SUCCESS
schedule_frequency - WEEKLY, DAILY, MONTHLY,YEARLY, ALL_RECORD_DELETE, SELECTIVE_RECORD_DELETE, ALL_CM_UPDATE,GPX_BOOT, GPX_SPLITTER, etc.

ペイロード条件のサンプル

以下は、プロジェクトの詳細を取得APIに対するペイロード条件リクエストの例です。

 {
  "condition": "and",
  "rules": [
    {
      "op": "EQ",
      "apiOp": "EQ",
      "values": [
        {
          "value": "PARTIAL_SUCCESS",
          "dataType": "string",
          "fieldType": "value"
        }
      ],
      "fieldInfo": {
        "name": "job_status",
        "dataType": "string",
        "fieldType": "field",
        "fieldAlias": "Status"
      }
    },
    {
      "op": "GT",
      "apiOp": "GT",
      "values": [
      
{
          "value": "2020-12-01",
          "dataType": "date",
          "fieldType": "value"
        }
      ],
      "fieldInfo": {
        "name": "run_for_date",
        "dataType": "date",
        "fieldType": "field",
        "fieldAlias": "Run Date"
      }
    }
  ]
}

リクエストのサンプル

以下は、フェッチジョブの詳細APIに対するリクエストの例です。

curl --location --request POST 'https://abstract-dhudm.develgs.com/v1/udm/integrationapi/jobDetails?limit=50&offset=0&order_by=modified_at&descending=true' \
--header 'accesskey: f1792c8c-84cb-444f-aff7-fc5e7b454ae6' \
--header 'projectId: 9e8c5a46-0e7f-4d8a-9031-81ffe69cf0d5' \
--header 'optionalResponseParams: udmJobId,dpPrimaryJobId' \

応答成功のサンプル

以下は、フェッチジョブの詳細APIに対する応答成功の例です。

{
  "result": true,
  "requestId": "c757f528-ac1a-4389-99dc-4e3eaa47d391",
  "data": [
    {
      "createdByName": "Arvind Singh",
      "lastModifiedAt": "2020-03-26 09:33:03.528703",
      "id": 48850,
      "tenantId": "9de7037b-20ef-4cfe-b74d-e150eeac3611",
      "udmJobId": "728b3e33-b061-458a-a8f9-3a6f0826a41c",
      "dpPrimaryJobId": "",
      "jobStatus": "SUCCESS",
      "scheduleFrequency": "external_identifiers_update",
      "runForDate": "2020-03-26",
      "type": "MANUAL",
      "startTime": "2020-03-26 09:32:44.523",
      "testRun": false
    },
    {
      "createdByName": "Arvind Singh",
      "lastModifiedAt": "2020-03-26 10:08:20.644",
      "id": 48906,
      "tenantId": "9de7037b-20ef-4cfe-b74d-e150eeac3611",
      "udmJobId": "ef8a8196-a4ee-4a51-8897-c5d837997934",
      "dpPrimaryJobId": "",
      "jobStatus": "SKIPPED",
      "scheduleFrequency": "daily",
      "runForDate": "2020-02-01",
      "message": "Skipping daily jobs older than last 45 days, will schedule only weekly jobs for skipped date range only if weekly sources are present",
      "type": "MANUAL",
      "startTime": "",
      "testRun": false
    }
  ]
}

応答失敗のサンプル

以下は、フェッチジョブの詳細APIに対する応答失敗の例です。

{
    "result": false,
    "errorCode": "2003",
    "errorDesc": "Bad Request, please check your input.",
    "requestId": "dffa8808-8097-43f4-9782-f224558a5d44",
    "message": "Bad Request, please check your input.",
    "messages": [
        "Project not available, its either deleted or never created, please contact tech support!!!"
    ]
}

サブジョブ詳細の取得

サブジョブの詳細を取得APIを使用すると、特定のAEプロジェクトおよびジョブに対するサブジョブ詳細を取得できます。projectIdとjobIdが分からない場合は、プロジェクトの詳細を取得とフェッチジョブの詳細APIを呼び出して詳細を取得できます。たとえば、プロジェクトに複数のオブジェクトがある場合、オブジェクトの詳細なログ情報を知りたくなります。

このAPIを使うと、ResponseParamsの入力に応じて、サブジョブの次の詳細を取得できます (データプロセスとデータロードの両方)。

サブジョブタイプ
最終更新日
サブジョブID
サブジョブステータス
データロードタイプ
実行日
開始時間
表示名

プロジェクトの詳細を取得する方法については、この記事の「プロジェクトの詳細を取得」セクションを参照してください。

ジョブの詳細を取得する方法については、この記事の「プロジェクトの詳細を取得」セクションを参照してください。

方法の詳細

APIの詳細	説明
エンドポイントのURL	<apiGatewayURL>/v1/udm/integrationapi/subJobDetails
リクエスト方法	ポスト
ヘッダー	アクセスキー：<GainsightAPI accessKey> projectId: <projectId> jobId: <jobId> optionalResponseParams: dpProcessUdmJobId, dpProcessSubJobId, dpProcessDpPrimaryJobId, dpProcessDpSubJobId, dlProcessUdmJobId, dlProcessSubJobId, dlProcessDpPrimaryJobId, dlProcessDpSubJobId

APIの詳細

説明

エンドポイントのURL

<apiGatewayURL>/v1/udm/integrationapi/subJobDetails

リクエスト方法

ポスト

ヘッダー

アクセスキー：<GainsightAPI accessKey>

projectId: <projectId>

jobId: <jobId>

optionalResponseParams: dpProcessUdmJobId, dpProcessSubJobId, dpProcessDpPrimaryJobId, dpProcessDpSubJobId, dlProcessUdmJobId, dlProcessSubJobId, dlProcessDpPrimaryJobId, dlProcessDpSubJobId

メモ：

より簡潔な応答を取得するには、定義済みの optionalResponseParamsをコンマで区切って入力します。
optionalResponseParamsで、dpはデータ処理を意味し、dlはデータロードを意味します。

リクエストのサンプル

以下は、サブジョブの詳細を取得APIに対するリクエストの例です。

 curl --location --request POST 'https://abstract-dhudm.develgs.com/v1/udm/integrationapi/subJobDetails' \
--header 'accesskey: f1792c8c-84cb-444f-aff7-fc5e7b454ae6' \
--header 'projectId: 9e8c5a46-0e7f-4d8a-9031-81ffe69cf0d5' \
--header 'jobId: 8af8c4c1-fa3c-4d25-81ed-b4c5bc75fbcc' \

応答成功のサンプル

以下は、サブジョブの詳細を取得APIに対する応答成功の例です。

{
  "result": true,
  "requestId": "95999e35-fcaf-46b9-b163-1b75fa5ba56c",
  "data": [
    {
      "subjobType": "COMPANY_AVATAR",
      "dpProcess": {
        "lastModifiedAt": "2021-02-01 07:09:18.146365",
        "id": 0,
        "tenantId": "9de7037b-20ef-4cfe-b74d-e150eeac3611",
        "udmJobId": "b81c4e20-3461-4c75-b603-8276472cac54",
        "subJobId": "d1e18354-efdf-4c51-a35d-cc40d164d8e5",
        "dpPrimaryJobId": "20210201070053850-udm-9de7-8c271216-31fc-4a82-a5ee-6ad29a41e9b6",
        "dpSubJobId": "20210201070059279-udm-9de7-b9603b44-43e4-425f-9a95-58e42bab35e3",
        "subJobStatus": "PARTIAL_SUCCESS",
        "dataLoadType": "COMPANY_AVATAR",
        "runForDate": "2021-01-29",
        "startTime": "2021-02-01 07:00:58.747",
        "displayName": "COMPANY INFORMATION"
      },
      "dataLoad": {
        "lastModifiedAt": "2021-02-01 07:09:21.331238",
        "id": 0,
        "tenantId": "9de7037b-20ef-4cfe-b74d-e150eeac3611",
        "udmJobId": "b81c4e20-3461-4c75-b603-8276472cac54",
        "subJobId": "63e8e12d-8224-4a7f-9834-18e736ea3c62",
        "dpPrimaryJobId": "20210201070053850-udm-9de7-8c271216-31fc-4a82-a5ee-6ad29a41e9b6",
        "dpSubJobId": "",
        "subJobStatus": "SUCCESS",
        "dataLoadType": "COMPANY_AVATAR",
        "runForDate": "2021-01-29",
        "startTime": "2021-02-01 07:09:18.164",
        "displayName": "COMPANY INFORMATION"
      }
    },
    {
      "subjobType": "PERSON_AVATAR",
      "dpProcess": {
        "lastModifiedAt": "2021-02-01 07:12:56.571328",
        "id": 0,
        "tenantId": "9de7037b-20ef-4cfe-b74d-e150eeac3611",
        "udmJobId": "b81c4e20-3461-4c75-b603-8276472cac54",
        "subJobId": "a89512a7-fe04-4391-b964-04cdfd3179c8",
        "dpPrimaryJobId": "20210201070053850-udm-9de7-8c271216-31fc-4a82-a5ee-6ad29a41e9b6",
        "dpSubJobId": "20210201070923000-udm-9de7-8d5b6ed5-cbae-40f5-ac42-6e10962a55a3",
        "subJobStatus": "PARTIAL_SUCCESS",
        "dataLoadType": "PERSON_AVATAR",
        "runForDate": "2021-01-29",
        "startTime": "2021-02-01 07:09:21.353",
        "displayName": "PERSON INFORMATION"
      },
      "dataLoad": {
        "lastModifiedAt": "2021-02-01 07:12:58.687005",
        "id": 0,
        "tenantId": "9de7037b-20ef-4cfe-b74d-e150eeac3611",
        "udmJobId": "b81c4e20-3461-4c75-b603-8276472cac54",
        "subJobId": "fd24ddb0-b473-4516-add5-ce43318effec",
        "dpPrimaryJobId": "20210201070053850-udm-9de7-8c271216-31fc-4a82-a5ee-6ad29a41e9b6",
        "dpSubJobId": "",
        "subJobStatus": "SUCCESS",
        "dataLoadType": "PERSON_AVATAR",
        "runForDate": "2021-01-29",
        "startTime": "2021-02-01 07:12:56.587",
        "displayName": "PERSON INFORMATION"
      }
    }
  ]
}

応答失敗のサンプル

以下は、サブジョブの詳細を取得 APIに対する応答失敗の例です。

{
    "result": false,
    "errorCode": "2003",
    "errorDesc": "Bad Request, please check your input.",
    "requestId": "76c76670-cc40-4df9-8b97-d1a701a924b0",
    "message": "Bad Request, please check your input.",
    "messages": [
        "Project not available, its either deleted or never created, please contact tech support!!!"
    ]
}

ダウンロードリンクを取得

このダウンロードリンクを取得するAPI使うことにより、特定のAEプロジェクト > ジョブ > サブジョブ > ロード タイプに対して、csvリンクを使用してデータロード情報を取得できます。projectId、jobId、subJobIdが分からない場合は、プロジェクトの詳細を取得、フェッチジョブの詳細、サブジョブの詳細を取得APIを呼び出して詳細を取得できます。

データプロセスおよびデータロード操作に関する完備したレポートを生成したい場合は、有効なレコード、無効なレコードの数、および重複を削除した後にオブジェクトにロードされたレコード数を把握するためにこのAPIを使用できます。

このAPIは、ダウンロードリンクの次の詳細を取得します。

リンクタイプ
ダウンロードリンク
タイプ

プロジェクトの詳細を取得する方法については、この記事の「プロジェクトの詳細を取得」セクションを参照してください。

ジョブの詳細を取得する方法については、この記事の「プロジェクトの詳細を取得」セクションを参照してください。

サブジョブの詳細を取得する方法については、この記事の「サブジョブの詳細を取得」セクションを参照してください。

方法の詳細

APIの詳細	説明
エンドポイントのURL	<apiGatewayURL>/v1/udm/integrationapi/downloadLinks
リクエスト方法	GET
ヘッダー	アクセスキー：<GainsightAPI accessKey> projectId: <projectId> jobId: <jobId> osubJobId : <subJobId> loadType : <loadType> loadType can be anything among the following: COMPANY_AVATAR,PERSON_AVATAR, COMPANY_AVATAR_WEEKLY, PERSON_AVATAR_WEEKLY, PERSON_DAILY_TIME_SERIES, etc.

APIの詳細

説明

エンドポイントのURL

<apiGatewayURL>/v1/udm/integrationapi/downloadLinks

リクエスト方法

GET

ヘッダー

アクセスキー：<GainsightAPI accessKey>

projectId: <projectId>

jobId: <jobId>

osubJobId : <subJobId>

loadType : <loadType>

loadType can be anything among the following: COMPANY_AVATAR,PERSON_AVATAR,

COMPANY_AVATAR_WEEKLY,

PERSON_AVATAR_WEEKLY,

PERSON_DAILY_TIME_SERIES, etc.

リクエストのサンプル

以下は、ダウンロードリンクを取得するAPIに対するリクエストの例です。

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' \

応答成功のサンプル

以下は、ダウンロードリンクを取得するAPIに対する応答成功の例です。

{
    "result": true,
    "requestId": "58b9a712-3353-4ddb-b8b8-a1dbbb66e5a4",
    "data": [
        {
            "linkType": "SDJHJHSD",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/8ffaf7a4-194d-4836-8a89-c04a67981ba3/VALID_DATA/downloadReady/cad_104_COMPANY_AVATAR_DAILYmerge_1612163108250.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b236e10ee05cba5d7bd0f82f545252c3f94d8a3cf6625315007e7cef596acbe5",
            "numberOfRecords": 0,
            "type": "VALID"
        },
        {
            "linkType": "SDJHJHSD",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/8ffaf7a4-194d-4836-8a89-c04a67981ba3/INVALID_DATA/downloadReady/cad_105_COMPANY_AVATAR_DAILYmerge_1612163109344.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=a8994a75b2ad15bec0d5f912702a621bc2e93996c9e1859a07eff072ef97e519",
            "numberOfRecords": 0,
            "type": "INVALID"
        },
        {
            "linkType": "SDJHJHSD",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/8ffaf7a4-194d-4836-8a89-c04a67981ba3/EXTRACTION/downloadReady/cad_103_COMPANY_AVATAR_DAILYmerge_1612163091256.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=9d481efc42985b02fb68eb302026d8f48cbb15aac56ee161f8e5b9b5c2191ec3",
            "numberOfRecords": 0,
            "type": "SOURCE"
        },
        {
            "linkType": "MDA_CUI",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/cbde781a-924e-47a0-a57e-082f85f81d21/EXTRACTION/downloadReady/cad_101_COMPANY_AVATAR_DAILYMDA3_1612163109380.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=f15b86574d973c1ecae71b15c21a849d8d75271802db809e495f049e5dffc3cf",
            "numberOfRecords": 2551,
            "type": "SOURCE"
        },
        {
            "linkType": "MDA_CUI",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/cbde781a-924e-47a0-a57e-082f85f81d21/VALID_DATA/downloadReady/cad_102valid_1612163145431.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=205d3a7ac61ded1c55a595935adbb705ff67cb519ed45524963959be8ea1c285",
            "numberOfRecords": 1006,
            "type": "VALID"
        },
        {
            "linkType": "MDA_CUI",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/cbde781a-924e-47a0-a57e-082f85f81d21/INVALID_DATA/downloadReady/cad_102invalid_1612163147534.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=df38e513a6053fd96bcbccec0ffa37d83f89511ce4de6caa09f50db70c19ba6a",
            "numberOfRecords": 1545,
            "type": "INVALID"
        },
        {
            "linkType": "Company Information",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/b81c4e20-3461-4c75-b603-8276472cac54/COMPANY_AVATAR/FINAL_OUTPUT_TASK/downloadReady/cad_106_COMPANY_AVATAR_DAILYjoin_1_1612163233401.csv.gz?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T083324Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604800&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b99e447b62773723d8d2a803adf0d63e81ecded1dc2d871659445dd6467edafc",
            "numberOfRecords": 1004,
            "type": "OBJECT"
        }
    ]
}

応答失敗のサンプル

以下は、ダウンロードリンクを取得する APIに対する応答失敗の例です。

{
    "result": false,
    "errorCode": "2003",
    "errorDesc": "Bad Request, please check your input.",
    "requestId": "c12a3bfb-d1a2-4d74-8ce2-26fffe128a3c",
    "message": "Bad Request, please check your input.",
    "messages": [
        "Project not available, its either deleted or never created, please contact tech support!!!"
    ]
}

カンパニーレゾリューションのダウンロードリンクを取得

会社の解決策のダウンロードリンクを取得する APIにより、特定のAEプロジェクト > ジョブに関して、csvリンクを使用してカンパニーレゾリューションのデータロード情報を取得できます。projectIdとjobIdが分からない場合は、プロジェクトの詳細を取得とフェッチジョブの詳細 APIを呼び出して詳細を取得できます。

データプロセスおよびデータロード操作に関する完備したレポートを生成したい場合は、クリーンアップされたデフォルトレコード数、および重複を削除した後にオブジェクトにロードされたレコード数を把握するためにこのAPIを使用できます。

このAPIは、ダウンロードリンクの次の詳細を取得します。

リンクタイプ
ダウンロードリンク
タイプ

プロジェクトの詳細を取得する方法については、この記事の「プロジェクトの詳細を取得」セクションを参照してください。

ジョブの詳細を取得する方法については、この記事の「プロジェクトの詳細を取得」セクションを参照してください。

方法の詳細

APIの詳細	説明
エンドポイントのURL	<apiGatewayURL>/v1/udm/integrationapi/companyResolutionDownloadLink
リクエスト方法	GET
ヘッダー	アクセスキー：<GainsightAPI accessKey> projectId: <projectId> jobId: <jobId>

APIの詳細

説明

エンドポイントのURL

<apiGatewayURL>/v1/udm/integrationapi/companyResolutionDownloadLink

リクエスト方法

GET

ヘッダー

アクセスキー：<GainsightAPI accessKey>

projectId: <projectId>

jobId: <jobId>

応答成功のサンプル

以下は、会社決議のダウンロードリンクAPIに対する応答成功の例です。

{
    "result": true,
    "requestId": "b10f2502-c1be-4e4b-ab13-3bdb81540f4d",
    "data": [
        {
            "linkType": "DEFAULT_RECORDS",
            "downloadLink": "https://gainsight-data-processing.s3.amazonaws.com/udm-data/9de7037b-20ef-4cfe-b74d-e150eeac3611/fb13a0f8-4dea-4564-ac07-b72b07c2489c/COMPANY_RESOLUTION/default_records_sched-ca30c47c-09bb-4c5c-8b1b-10f411f57ae7.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20210205T092043Z&X-Amz-SignedHeaders=host&X-Amz-Expires=604799&X-Amz-Credential=AKIAVHA6EWHZR5T4GXU3%2F20210205%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=bc9fdd19593d590179b86078ca88b8aec2d6100b142d15f7908f1e8211681d20",
            "numberOfRecords": 0,
            "type": "OBJECT"
        }
    ]
}

応答失敗のサンプル

以下は、会社決議のダウンロードリンクAPIに対する応答失敗の例です。

{
    "result": false,
    "errorCode": "2003",
    "errorDesc": "Bad Request, please check your input.",
    "requestId": "3ec598ae-d963-40ff-9922-481cd993112c",
    "message": "Bad Request, please check your input.",
    "messages": [
        "Project not available, its either deleted or never created, please contact tech support!!!"
    ]
}

追加のリソース

アドプションエクスプローラーでプロジェクトを手動でスケジューリング/実行する方法については、ログの記事を参照してください。
アクセスキーを生成または共有する方法については、APIアクセスキーの生成に関する記事を参照してください。

概要

前提条件

プロジェクトの詳細を取得

方法の詳細

リクエストのサンプル

応答成功のサンプル

応答失敗のサンプル

ジョブ詳細の取得

方法の詳細

ペイロード条件 [オプション]

ペイロード条件のサンプル

リクエストのサンプル

応答成功のサンプル

応答失敗のサンプル

サブジョブ詳細の取得

方法の詳細

リクエストのサンプル

応答成功のサンプル

応答失敗のサンプル

ダウンロードリンクを取得

方法の詳細

リクエストのサンプル

応答成功のサンプル

応答失敗のサンプル

カンパニーレゾリューションのダウンロード リンクを取得

方法の詳細

応答成功のサンプル

応答失敗のサンプル

追加のリソース

カンパニーレゾリューションのダウンロードリンクを取得