機械翻訳について

ジャンプ先

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

コラボレーション処理への属性の追加

post

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

リクエスト

パス・パラメータ

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

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• 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コントロール。
• 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

  処理属性の表示順序。
• RequestAttribFlag: boolean
  タイトル: Included in Request

  最大長: 1

  デフォルト値: false

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

  最大長: 1

  デフォルト値: false

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

{
    "type":"object",
    "properties":{
        "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
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The display order of the action attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "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
            }
        },
        "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"
            }
        },
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The channel associated with the action attribute.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "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
        },
        "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
        },
        "DefaultValue":{
            "title":"Default Value",
            "maxLength":4000,
            "type":"string",
            "description":"The default value of the action attribute.",
            "nullable":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"
            }
        },
        "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"
            }
        },
        "AttribName":{
            "title":"Attribute Name",
            "maxLength":64,
            "type":"string",
            "description":"The business object attribute name associated with the collaboration action.",
            "nullable":false
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : 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."
        }
    }
}

リンク

ControlTypeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

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

DataTypeCdLOV

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

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

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

「トップに戻る」