Jira Service Management

認証を構成する

使用する認証に基づいて詳細を入力します。

• OAuth2.0
  • クライアント ID: 外部アプリケーションによって提供されるクライアント ID。
  • スコープ: 権限スコープ。 offline_access スコープは、Jira Service Management コネクタで使用する必要があります。スコープの仕組みと Jira Service Management で利用可能なすべてのスコープを確認するには、スコープをご覧ください。
  • クライアント シークレット: Secret Manager のシークレットを選択します。 この認証を構成する前に、Secret Manager のシークレットを作成しておく必要があります。
  • シークレットのバージョン: クライアント シークレットの Secret Manager シークレットのバージョン。

  Authorization code 認証タイプの場合は、接続を作成した後、認証を構成するためにいくつかの追加手順を行う必要があります。詳しくは、接続作成後の追加手順をご覧ください。

• ベーシック
  • ユーザー名: 認証に使用される Jira Service Management ユーザー アカウント。
  • パスワード: アカウントに関連付けられたパスワード。
• APIToken
  • ユーザー名: API トークンの作成に使用した Jira Service Management のユーザー名。
  • API トークン: ユーザー名のパスワードが API トークンになります。Jira Cloud ユーザー名に関連付けられた API トークンを含む Secret Manager の Secret を選択します。

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

• エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。

  ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。

• オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
  • リスト
  • 取得
  • 作成
  • 更新
  • 削除

  使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。

• アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

システムの上限

Jira Service Management コネクタは、ノードごとに 1 秒あたり 15 件のトランザクションを処理することができ、この上限を超えるトランザクションはすべてスロットルされます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

アクション

Jira Service Management コネクタには、AddAttachment、AttachTemporaryFile、CreateCustomer などのアクションが用意されています。アクションの構成方法については、アクションの例をご覧ください。

アクションの例

このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。

例 - 一時ファイルを添付する

この例では、一時ファイルを添付し、添付ファイルの追加に使用する添付ファイル ID を指定します。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [AttachTemporaryFile] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

     {
       "Content": "test to create 1 temporaryid"
     }

アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

[{
    "TemporaryAttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
    "FileName": "16324233309516250343.connector.txt"
}] 

例 - 添付ファイルを追加する

この例では、入力ペイロードで指定されたリクエスト ID に一時ファイルを添付します。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [AddAttachment] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
       "AttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
       "RequestId": "10032"
   }  

アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

[{
  "Success": "true",
  "filename": "16324233309516250343.connector.txt",
}] 

例 - 顧客を作成する

この例では、顧客を作成します。

1. [Configure connector task] ダイアログで、[Actions] をクリックします。
2. [CreateCustomer] アクションを選択してから、[完了] をクリックします。
3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {
     "Email": "something@something.com",
     "FullName": "Something"
   } 

アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

[{
    "Key": null,
    "AccountId": "qm:476582de-e968-4bc9-b0be-0349e8e3ec97:244dd7e4-0b49-4468-adac-561ab09bf2bb",
    "Name": null,
    "EmailAddress": "something@something.com",
    "DisplayName": "Something",
    "Active": "true",
    "Timezone": "Asia/Calcutta",
    "_links.jirarest": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb",
    "_links.avatarurls.48x48": "https://avatar-management.services.atlassian.com/default/48",
    "_links.avatarurls.24x24": "https://avatar-management.services.atlassian.com/default/24",
    "_links.avatarurls.16x16": "https://avatar-management.services.atlassian.com/default/16",
    "_links.avatarurls.32x32": "https://avatar-management.services.atlassian.com/default/32",
    "_links.self": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb"
}]

エンティティ オペレーションの例

例 - すべてのリクエストを一覧表示する

この例では、Requests エンティティ内のすべてのリクエストを一覧表示します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity リストから [リクエスト] を選択します。
3. [LIST] オペレーションを選択してから、[完了] をクリックします。

例 - 特定のサービスデスク ID からのリクエストを取得する

この例では、Requests エンティティから RequestKey が DP1-14 のリクエストを取得します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Requests を選択します。
3. [LIST] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで [filterClause] をクリックしてから、[デフォルト値] フィールドに「RequestKey='DP1-14'」と入力します。

   ここで、RequestKey は Requests エンティティの主キー値です。

例 - リクエストを作成する

この例では、Requests エンティティにリクエストを作成します。

1. [Configure connector task] ダイアログで、[Entities] をクリックします。
2. Entity から Requests を選択します。
3. [Create] オペレーションを選択してから、[完了] をクリックします。
4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

   {, , ,) VALUES ('2', '1', '','test');
       "RequestTypeId": "2",
       "ServiceDeskId": "1",
       "Summary": "test",
       "Description": "test"
     }
     

   統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

    {
       "RequestId": "10032"
     } 
     

統合で Jira Service Management 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

• Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
• Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。