機械翻訳について

ジャンプ先

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

フィード・イベントの作成

post

/crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent

リクエスト

パス・パラメータ

• FeedId(required): string
  フィードの一意の識別子。
• FeedObjectId(required): string
  フィード・オブジェクトの一意の識別子。

ヘッダー・パラメータ

• 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

ソースを表示

• ActiveFlag: boolean
  タイトル: Active Status Indicator

  最大長: 1

  デフォルト値: true

  フィードを生成するためのイベントのステータス。
• EventCode(required): string
  タイトル: Event Code

  最大長: 30

  フィードを生成する必要があるイベントのタイプ。
• FeedAttr: array Feed Attributes
  タイトル: Feed Attributes

  フィード属性リソースは、フィード・オブジェクトの属性を作成、更新および削除するために使用されます。
• FeedEventDetails: 文字列(バイト)
  タイトル: Feed Event Details

  「このCLOB」フィールドには、JSONの追加情報が含まれます。
• FeedEventId: string
  タイトル: Feed Event ID

  最大長: 64

  フィード・イベントの一意の識別子。
• FeedObjectId(required): string
  タイトル: Feed Object ID

  最大長: 64

  フィード・オブジェクトの一意の識別子。
• SignalDefId: string
  タイトル: Signal Definition ID

  最大長: 64

  シグナルによって生成されるシグナル定義の識別子。

{
    "required":[
        "EventCode",
        "FeedObjectId"
    ],
    "type":"object",
    "properties":{
        "FeedEventId":{
            "title":"Feed Event ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the feed event.",
            "nullable":false
        },
        "FeedObjectId":{
            "title":"Feed Object ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the feed object.",
            "nullable":false
        },
        "SignalDefId":{
            "title":"Signal Definition ID",
            "maxLength":64,
            "type":"string",
            "description":"The identifier for signal definition that is generated by signals.",
            "nullable":true
        },
        "ActiveFlag":{
            "title":"Active Status Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The status of the event for generating the feed.",
            "nullable":false,
            "default":true
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of event for which the feed needs to be generated.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FeedAttr":{
            "title":"Feed Attributes",
            "type":"array",
            "description":"The feed attributes resource is used to create, update, and delete the attributes of the feed objects.",
            "items":{
                "$ref":"#/components/schemas/feedConfigurations-FeedObject-FeedEvent-FeedAttr-item-post-request"
            }
        },
        "FeedEventDetails":{
            "title":"Feed Event Details",
            "type":"string",
            "description":"This CLOB field contains additional information of JSON.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : フィード属性

タイプ: array

タイトル: Feed Attributes

フィード属性リソースは、フィード・オブジェクトの属性を作成、更新および削除するために使用されます。

ソースを表示

• Array of: object schema

{
    "title":"Feed Attributes",
    "type":"array",
    "description":"The feed attributes resource is used to create, update, and delete the attributes of the feed objects.",
    "items":{
        "$ref":"#/components/schemas/feedConfigurations-FeedObject-FeedEvent-FeedAttr-item-post-request"
    }
}

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

タイプ: object

ソースを表示

• AttributeName: string
  タイトル: Attribute Name

  最大長: 100

  フィード・オブジェクトの属性の名前。
• ChangeIndicatorFlag: boolean
  タイトル: Change Indicator

  最大長: 1

  デフォルト値: false

  属性が更新され、シグナルが生成されるタイミングを示す変更インジケータ。
• DisplayFlag: boolean
  最大長: 1

  デフォルト値: true

  フラグは、フィールドが内部属性であるかどうかを示します
• FeedAttrDetails: 文字列(バイト)
  タイトル: Feed Attribute Details

  JSONの追加情報を含むCLOB。
• FeedAttributeId: string
  タイトル: Feed Attribute ID

  最大長: 64

  フィード・オブジェクトの属性の一意の識別子。
• FeedEventId: string
  タイトル: Feed Event ID

  最大長: 64

  フィード・オブジェクトの属性の名前。
• FeedObjectId: string
  タイトル: Feed Object ID

  最大長: 64

  フィード・オブジェクトの一意の識別子。
• PayloadFlag: boolean
  タイトル: Payload Indicator

  最大長: 1

  デフォルト値: true

  webサービスのJSON形式のテキスト。
• SortFlag: boolean
  最大長: 1

  このフラグは、フィールドをソートできるかどうかを示します。

{
    "type":"object",
    "properties":{
        "FeedEventId":{
            "title":"Feed Event ID",
            "maxLength":64,
            "type":"string",
            "description":"The name of the attribute of the feed object.",
            "nullable":true
        },
        "PayloadFlag":{
            "title":"Payload Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The JSON-formatted text of the web service.",
            "nullable":false,
            "default":true
        },
        "FeedObjectId":{
            "title":"Feed Object ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier for feed object.",
            "nullable":true
        },
        "ChangeIndicatorFlag":{
            "title":"Change Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The change indicator that denotes when an attribute is updated and the signal is generated.",
            "nullable":false,
            "default":false
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the attribute of the feed object.",
            "nullable":false
        },
        "SortFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicates if the field can be sorted.",
            "nullable":true
        },
        "FeedAttrDetails":{
            "title":"Feed Attribute Details",
            "type":"string",
            "description":"The CLOB that contains additional information of JSON.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DisplayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicates if the field is an internal attribute",
            "nullable":true,
            "default":true
        },
        "FeedAttributeId":{
            "title":"Feed Attribute ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier for attribute of the feed object.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : feedConfigurations-FeedObject-FeedEvent-item-response

タイプ: object

ソースを表示

• ActiveFlag: boolean
  タイトル: Active Status Indicator

  最大長: 1

  デフォルト値: true

  フィードを生成するためのイベントのステータス。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• DeleteFlag: boolean
  読取り専用: true

  最大長: 1

  レコードを削除するためのアクセス権がユーザーに付与されているかどうかを示します。
• EventCode: string
  タイトル: Event Code

  最大長: 30

  フィードを生成する必要があるイベントのタイプ。
• FeedAttr: array Feed Attributes
  タイトル: Feed Attributes

  フィード属性リソースは、フィード・オブジェクトの属性を作成、更新および削除するために使用されます。
• FeedEventDetails: 文字列(バイト)
  タイトル: Feed Event Details

  「このCLOB」フィールドには、JSONの追加情報が含まれます。
• FeedEventId: string
  タイトル: Feed Event ID

  最大長: 64

  フィード・イベントの一意の識別子。
• FeedObjectId: string
  タイトル: Feed Object ID

  最大長: 64

  フィード・オブジェクトの一意の識別子。
• 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

  リソース・インスタンスに関連付けられたリンク関係。
• SignalDefId: string
  タイトル: Signal Definition ID

  最大長: 64

  シグナルによって生成されるシグナル定義の識別子。
• UpdateFlag: boolean
  読取り専用: true

  最大長: 1

  レコードを更新するためのアクセス権がユーザーに付与されているかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active Status Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The status of the event for generating the feed.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of event for which the feed needs to be generated.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FeedAttr":{
            "title":"Feed Attributes",
            "type":"array",
            "description":"The feed attributes resource is used to create, update, and delete the attributes of the feed objects.",
            "items":{
                "$ref":"#/components/schemas/feedConfigurations-FeedObject-FeedEvent-FeedAttr-item-response"
            }
        },
        "FeedEventDetails":{
            "title":"Feed Event Details",
            "type":"string",
            "description":"This CLOB field contains additional information of JSON.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FeedEventId":{
            "title":"Feed Event ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the feed event.",
            "nullable":false,
            "x-queryable":true
        },
        "FeedObjectId":{
            "title":"Feed Object ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the feed object.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SignalDefId":{
            "title":"Signal Definition ID",
            "maxLength":64,
            "type":"string",
            "description":"The identifier for signal definition that is generated by signals.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record 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 of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : フィード属性

タイプ: array

タイトル: Feed Attributes

フィード属性リソースは、フィード・オブジェクトの属性を作成、更新および削除するために使用されます。

ソースを表示

• Array of: object feedConfigurations-FeedObject-FeedEvent-FeedAttr-item-response

{
    "title":"Feed Attributes",
    "type":"array",
    "description":"The feed attributes resource is used to create, update, and delete the attributes of the feed objects.",
    "items":{
        "$ref":"#/components/schemas/feedConfigurations-FeedObject-FeedEvent-FeedAttr-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"
    }
}

ネストされたスキーマ : feedConfigurations-FeedObject-FeedEvent-FeedAttr-item-response

タイプ: object

ソースを表示

• AttributeName: string
  タイトル: Attribute Name

  最大長: 100

  フィード・オブジェクトの属性の名前。
• ChangeIndicatorFlag: boolean
  タイトル: Change Indicator

  最大長: 1

  デフォルト値: false

  属性が更新され、シグナルが生成されるタイミングを示す変更インジケータ。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• DeleteFlag: boolean
  読取り専用: true

  最大長: 1

  レコードを削除するためのアクセス権がユーザーに付与されているかどうかを示します。
• DisplayFlag: boolean
  最大長: 1

  デフォルト値: true

  フラグは、フィールドが内部属性であるかどうかを示します
• FeedAttrDetails: 文字列(バイト)
  タイトル: Feed Attribute Details

  JSONの追加情報を含むCLOB。
• FeedAttributeId: string
  タイトル: Feed Attribute ID

  最大長: 64

  フィード・オブジェクトの属性の一意の識別子。
• FeedEventId: string
  タイトル: Feed Event ID

  最大長: 64

  フィード・オブジェクトの属性の名前。
• FeedObjectId: string
  タイトル: Feed Object ID

  最大長: 64

  フィード・オブジェクトの一意の識別子。
• 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

  リソース・インスタンスに関連付けられたリンク関係。
• PayloadFlag: boolean
  タイトル: Payload Indicator

  最大長: 1

  デフォルト値: true

  webサービスのJSON形式のテキスト。
• SortFlag: boolean
  最大長: 1

  このフラグは、フィールドをソートできるかどうかを示します。
• UpdateFlag: boolean
  読取り専用: true

  最大長: 1

  レコードを更新するためのアクセス権がユーザーに付与されているかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayloadFlag":{
            "title":"Payload Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The JSON-formatted text of the web service.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ChangeIndicatorFlag":{
            "title":"Change Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The change indicator that denotes when an attribute is updated and the signal is generated.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "SortFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicates if the field can be sorted.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FeedEventId":{
            "title":"Feed Event ID",
            "maxLength":64,
            "type":"string",
            "description":"The name of the attribute of the feed object.",
            "nullable":true,
            "x-queryable":true
        },
        "FeedObjectId":{
            "title":"Feed Object ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier for feed object.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the attribute of the feed object.",
            "nullable":false,
            "x-queryable":true
        },
        "FeedAttrDetails":{
            "title":"Feed Attribute Details",
            "type":"string",
            "description":"The CLOB that contains additional information of JSON.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DisplayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicates if the field is an internal attribute",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record 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 of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeedAttributeId":{
            "title":"Feed Attribute ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier for attribute of the feed object.",
            "nullable":false,
            "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."
        }
    }
}

リンク

FeedAttr

操作: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedEvent/{FeedEventId}/child/FeedAttr

パラメータ:

• FeedEventId: $request.path.FeedEventId
• FeedId: $request.path.FeedId
• FeedObjectId: $request.path.FeedObjectId

(FeedAttrのリソース)

「トップに戻る」