機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

コラボレーション・アクションの取得

get

/crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}

リクエスト

パス・パラメータ

• CollabActionNumber(required): string
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : collaborationActions-item-response

タイプ: object

ソースを表示

• actionAttributes: array Action Attributes
  タイトル: Action Attributes

  属性リソースを使用すると、コラボレーション・ネットワークで使用される属性を表示、作成、更新および削除できます。 これらの属性は、処理の実行時にコラボレーション・ネットワークから送受信されます。
• CatalogCd: string
  タイトル: REST Catalog

  最大長: 30

  デフォルト値: crmRestApi

  ビジネス・オブジェクトのエンドポイントの生成に使用されるRESTカタログ。
• ChannelId: integer (int64)
  タイトル: Channel ID

  コラボレーション処理に関連付けられたサービス・チャネルの一意の識別子。
• CollabActionCd: string
  タイトル: Action Code

  最大長: 30

  コラボレーション処理を識別する一意のコード。
• CollabActionId: integer (int64)
  タイトル: Action ID

  読取り専用: true

  コラボレーション処理の一意の識別子。
• CollabActionMethod: string
  タイトル: Action Method

  最大長: 64

  GETやPOSTなど、コラボレーション処理によって呼び出されるREST API処理。
• CollabActionName: string
  タイトル: Action Name

  最大長: 64

  コラボレーション処理の表示名。
• CollabActionNumber: string
  タイトル: Action Number

  最大長: 30

  コラボレーション処理の代替一意識別子。
• CollabActionTypeCd: string
  タイトル: Action Type

  最大長: 30

  APIのコールやダイアログの表示など、コラボレーション・アクションの実行時の動作を指定します。
• ControlTypeCd: string
  タイトル: User Interface Component

  最大長: 30

  コラボレーション・ネットワークで処理を表示するために使用されるUIコントロール。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  コラボレーション処理を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  コラボレーション処理が作成された日付。
• Description: string
  タイトル: Description

  最大長: 1000

  コラボレーション処理の説明。
• DisplaySequence: integer (int64)
  タイトル: Display Sequence

  コラボレーション処理の表示順序。 これは主に、コラボレーション・ネットワークUIに表示される子処理に適用されます。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  コラボレーション処理が最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  コラボレーション処理を最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  コラボレーション処理を最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectName: string
  タイトル: Business Object

  最大長: 64

  サービス・リクエストや商談など、コラボレーション処理に関連付けられたビジネス・オブジェクト。
• ParentActionId: integer (int64)
  タイトル: Parent Action ID

  コラボレーション処理の親処理の一意識別子です。
• RequestContentType: string
  タイトル: Request Content Type

  最大長: 64

  REST APIリクエスト・ペイロードのコンテンツ・タイプ。
• RequestEndPoint: string
  タイトル: Request End Point

  最大長: 4000

  コラボレーション・アクションのリクエストAPIのエンドポイント。
• RequestPayload: 文字列(バイト)
  タイトル: Request Payload

  リクエストAPIのリクエスト・ペイロード。
• ResponseContentType: string
  タイトル: Response Content Type

  最大長: 64

  REST APIレスポンスのコンテンツ・タイプ。
• ResponseEntityTypeCd: string
  タイトル: Response Type

  最大長: 30

  処理属性やペイロードなど、コラボレーション処理のレスポンス・タイプ。
• ResponseMsgTypeCd: string
  タイトル: Response Visibility

  最大長: 30

  プライベートまたはパブリックなど、コラボレーション・ネットワークでの処理レスポンスの表示を示します。
• ResponsePayload: 文字列(バイト)
  タイトル: Response Payload

  コラボレーション処理のレスポンス。
• StatusCd: string
  タイトル: Status

  最大長: 30

  デフォルト値: DRAFT

  DRAFTやACTIVEなどのコラボレーション処理のステータス。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the collaboration action was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the collaboration action.",
            "nullable":true,
            "x-queryable":true
        },
        "CatalogCd":{
            "title":"REST Catalog",
            "maxLength":30,
            "type":"string",
            "description":"The REST catalog used to generate the endpoint for the business object.",
            "nullable":true,
            "default":"crmRestApi",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CollabActionMethod":{
            "title":"Action Method",
            "maxLength":64,
            "type":"string",
            "description":"The REST API action invoked by the collaboration action such as GET or POST.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display sequence of the collaboration action. This is primarily applicable to child actions that are displayed on the collaboration network UI.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponseMsgTypeCd":{
            "title":"Response Visibility",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the visibility of the action response in the collaboration network such as private or public.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "actionAttributes":{
            "title":"Action Attributes",
            "type":"array",
            "description":"The attributes resource lets you view, create, update, and delete attributes used in a collaboration network. These attributes are sent or received from the collaboration network when an action is performed.",
            "items":{
                "$ref":"#/components/schemas/collaborationActions-actionAttributes-item-response"
            }
        },
        "CollabActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the collaboration action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the service channel associated with the collaboration action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResponsePayload":{
            "title":"Response Payload",
            "type":"string",
            "description":"The response of the collaboration action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CollabActionTypeCd":{
            "title":"Action Type",
            "maxLength":30,
            "type":"string",
            "description":"Specifies what the collaboration action does when run, such as call an API or show a dialog.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ControlTypeCd":{
            "title":"User Interface Component",
            "maxLength":30,
            "type":"string",
            "description":"The UI controls used to display the action on the collaboration network.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequestContentType":{
            "title":"Request Content Type",
            "maxLength":64,
            "type":"string",
            "description":"The content type of the REST API request payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CollabActionName":{
            "title":"Action Name",
            "maxLength":64,
            "type":"string",
            "description":"The display name of the collaboration action.",
            "nullable":false,
            "x-queryable":true
        },
        "RequestPayload":{
            "title":"Request Payload",
            "type":"string",
            "description":"The request payload for the request API.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the collaboration action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the collaboration action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentActionId":{
            "title":"Parent Action ID",
            "type":"integer",
            "description":"The unique identifier of the parent action for the collaboration action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the collaboration action such as DRAFT or ACTIVE.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResponseContentType":{
            "title":"Response Content Type",
            "maxLength":64,
            "type":"string",
            "description":"The content type of the REST API response.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestEndPoint":{
            "title":"Request End Point",
            "maxLength":4000,
            "type":"string",
            "description":"The endpoint of the Request API for the collaboration action.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseEntityTypeCd":{
            "title":"Response Type",
            "maxLength":30,
            "type":"string",
            "description":"The response type of collaboration actions such as Action Attributes or Payload.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectName":{
            "title":"Business Object",
            "maxLength":64,
            "type":"string",
            "description":"The business object associated with the collaboration action such as service request or opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "CollabActionCd":{
            "title":"Action Code",
            "maxLength":30,
            "type":"string",
            "description":"A unique code that identifier the collaboration action.",
            "nullable":true,
            "x-queryable":true
        },
        "CollabActionNumber":{
            "title":"Action Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the collaboration action.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the collaboration action was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the collaboration action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 処理属性

タイプ: array

タイトル: Action Attributes

属性リソースを使用すると、コラボレーション・ネットワークで使用される属性を表示、作成、更新および削除できます。 これらの属性は、処理の実行時にコラボレーション・ネットワークから送受信されます。

ソースを表示

• Array of: object collaborationActions-actionAttributes-item-response

{
    "title":"Action Attributes",
    "type":"array",
    "description":"The attributes resource lets you view, create, update, and delete attributes used in a collaboration network. These attributes are sent or received from the collaboration network when an action is performed.",
    "items":{
        "$ref":"#/components/schemas/collaborationActions-actionAttributes-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : collaborationActions-actionAttributes-item-response

タイプ: object

ソースを表示

• AttribId: integer (int64)
  タイトル: Attribute ID

  読取り専用: true

  処理属性の一意の識別子。
• AttribName: string
  タイトル: Attribute Name

  最大長: 64

  コラボレーション処理に関連付けられたビジネス・オブジェクト属性名です。
• ChannelId: integer (int64)
  タイトル: Channel ID

  処理属性に関連付けられたチャネル。
• CollabActionId: integer (int64)
  タイトル: Action ID

  属性に関連付けられたコラボレーション処理の一意の識別子。
• ContextAttribFlag: boolean
  タイトル: Business Object Identifier

  最大長: 1

  デフォルト値: false

  コラボレーション・ネットワークおよびCX Salesとの間で受け渡すためのコンテキスト属性として処理属性が使用されるかどうかを示します。
• ControlTypeCd: string
  タイトル: User Interface Component

  最大長: 30

  リストやテキスト・ボックスなどのコラボレーション・ネットワークに属性を表示するために使用されるUIコントロール。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  処理属性を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  処理属性が作成された日付。
• DataSource: string
  タイトル: End Point

  最大長: 4000

  タイプの属性の値リストを取得するAPI。
• DataSourceLabelAttrib: string
  タイトル: Option Label

  最大長: 64

  処理属性の表示値として使用されるAPI属性。 これは、管理タイプがリストである処理属性に適用されます。
• DataSourceValueAttrib: string
  タイトル: Option Value

  最大長: 64

  選択した処理属性値の保存に使用するAPI属性。 これは、管理タイプがリストである処理属性に適用されます。
• DataTypeCd: string
  タイトル: Data Type

  最大長: 30

  日時や数値など、コラボレーション処理属性のデータ型です。
• DeepLink: string
  タイトル: Deep Link

  最大長: 1000

  アクション属性に関連付けられたオブジェクトにリンクするディープ・リンクURL形式。
• DefaultValue: string
  タイトル: Default Value

  最大長: 4000

  処理属性のデフォルト値。
• DisplayName: string
  タイトル: Display Name

  最大長: 64

  コラボレーション・ネットワークで属性を表示したときに表示される処理属性のラベル。
• DisplaySequence: integer (int64)
  タイトル: Display Sequence

  処理属性の表示順序。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  処理属性が最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  処理属性を最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  アクション属性を最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• RequestAttribFlag: boolean
  タイトル: Included in Request

  最大長: 1

  デフォルト値: false

  アクション属性がリクエスト・ペイロードの一部であるかどうかを示します。
• ResponseAttribFlag: boolean
  タイトル: Included in Response

  最大長: 1

  デフォルト値: false

  アクション属性がレスポンス・ペイロードの一部であるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the action attribute was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSourceValueAttrib":{
            "title":"Option Value",
            "maxLength":64,
            "type":"string",
            "description":"The API attribute used to save the selected action attribute value. This applies to action attributes with control type as List.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display order of the action attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeepLink":{
            "title":"Deep Link",
            "maxLength":1000,
            "type":"string",
            "description":"A deep link URL format that links to the object associated with the action attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttribId":{
            "title":"Attribute ID",
            "type":"integer",
            "description":"The unique identifier of the action attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CollabActionId":{
            "title":"Action ID",
            "type":"integer",
            "description":"The unique identifier of the collaboration action associated with the attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataTypeCd":{
            "title":"Data Type",
            "maxLength":30,
            "type":"string",
            "description":"The data type of collaboration action attributes such as Date Time or Number.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The channel associated with the action attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DataSourceLabelAttrib":{
            "title":"Option Label",
            "maxLength":64,
            "type":"string",
            "description":"The API attribute used as the display value of the action attribute. This applies to action attributes with control type as List.",
            "nullable":true,
            "x-queryable":true
        },
        "DataSource":{
            "title":"End Point",
            "maxLength":4000,
            "type":"string",
            "description":"The API to get the a list of values for an attribute of type list.",
            "nullable":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":4000,
            "type":"string",
            "description":"The default value of the action attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestAttribFlag":{
            "title":"Included in Request",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the action attribute is part of the request payload.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ControlTypeCd":{
            "title":"User Interface Component",
            "maxLength":30,
            "type":"string",
            "description":"The UI controls used to display the attributes on the collaboration network such as List or Text box.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AttribName":{
            "title":"Attribute Name",
            "maxLength":64,
            "type":"string",
            "description":"The business object attribute name associated with the collaboration action.",
            "nullable":false,
            "x-queryable":true
        },
        "ContextAttribFlag":{
            "title":"Business Object Identifier",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the action attribute is used as the context attribute for passing to and from the collaboration network and CX Sales.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":64,
            "type":"string",
            "description":"The label of the action attribute displayed when displaying the attribute in the collaboration network.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResponseAttribFlag":{
            "title":"Included in Response",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the action attribute is part of the response payload.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the action attribute was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the action attributes.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

リンク

CatalogCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_CATALOG_TYPE_CD

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: CatalogCd;ターゲット属性: LookupCode
• 表示属性: 意味

CollabActionMethodLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_ACT_MET_TYPE_CD

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: CollabActionMethod;ターゲット属性: LookupCode
• 表示属性: 意味

CollabActionTypeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_ACT_TYPE_CD

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: CollabActionTypeCd;ターゲット属性: LookupCode
• 表示属性: 意味

ControlTypeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_ACT_CON_TYPE_CD

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: ControlTypeCd;ターゲット属性: LookupCode
• 表示属性: 意味

ResponseEntityTypeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_RES_ENT_TYPE_CD

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: ResponseEntityTypeCd;ターゲット属性: LookupCode
• 表示属性: 意味

ResponseMsgTypeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_RES_MSG_TYPE_CD

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: ResponseMsgTypeCd;ターゲット属性: LookupCode
• 表示属性: 意味

StatusCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DORA_SVC_COLLAB_ACT_STATUS_CD

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: StatusCd;ターゲット属性: LookupCode
• 表示属性: 意味

actionAttributes

操作: /crmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}/child/actionAttributes

パラメータ:

• CollabActionNumber: $request.path.CollabActionNumber

属性リソースを使用すると、コラボレーション・ネットワークで使用される属性を表示、作成、更新および削除できます。 これらの属性は、処理の実行時にコラボレーション・ネットワークから送受信されます。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、コラボレーション・アクションを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/collaborationActions/{CollabActionNumber}

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "CollabActionId": 300100547032351,
    "CollabActionName": "Submit Task",
    "CollabActionMethod": "POST",
    "RequestEndPoint": "/crmRestApi/resources/latest/activities",
    "RequestContentType": "application/vnd.oracle.adf.resourceitem+json",
    "ResponseContentType": "application/vnd.oracle.adf.resourceitem+json",
    "CreationDate": "2021-09-30T03:26:55.909+00:00",
    "CreatedBy": "SEED_DATA_FROM_APPLICATION",
    "LastUpdateDate": "2021-09-30T03:26:55.918+00:00",
    "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
    "LastUpdateLogin": "-1",
    "ResponseEntityTypeCd": "PAYLOAD",
    "ResponseMsgTypeCd": "PRIVATE",
    "CollabActionCd": "ec-submit-task",
    "CollabActionTypeCd": "INVOKE_API",
    "ObjectName": "Opportunity",
    "ParentActionId": 300100547032345,
    "ControlTypeCd": null,
    "DisplaySequence": 1,
    "ChannelId": null,
    "CollabActionNumber": "ec-submit-task",
    "Description": null,
    "StatusCd": "ACTIVE",
    "CatalogCd": "crmRestApi",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/ec-submit-task",
            "name": "collaborationActions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/ec-submit-task",
            "name": "collaborationActions",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/ec-submit-task/child/actionAttributes",
            "name": "actionAttributes",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/ec-submit-task/enclosure/RequestPayload",
            "name": "RequestPayload",
            "kind": "other"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/collaborationActions/ec-submit-task/enclosure/ResponsePayload",
            "name": "ResponsePayload",
            "kind": "other"
        }
    ]
}

「トップに戻る」