機械翻訳について

ジャンプ先

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

フィード・オブジェクトの更新

patch

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

リクエスト

パス・パラメータ

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

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• DefaultSort: string
  最大長: 100

  このフィールドには、フィード・オブジェクトのソートに使用されるデフォルト属性が含まれます。
• FeedAttr: array Feed Attributes
  タイトル: Feed Attributes

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

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

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

  最大長: 20

  フィードのオブジェクト・タイプ。子オブジェクトまたは動的選択リストです。
• FeedSupportedAttributes: array Feed Supported Attributes
  タイトル: Feed Supported Attributes

  フィード属性LOVリソースは、フィード属性の値リストを表示するために使用されます。
• RestResource: string
  最大長: 600

  このフィールドには、フィード・オブジェクトの残りのリソースURLが格納されます。
• SourceAttribute: string
  タイトル: Source Attribute

  最大長: 100

  親フィード構成の動的選択リスト属性。

{
    "type":"object",
    "properties":{
        "SourceAttribute":{
            "title":"Source Attribute",
            "maxLength":100,
            "type":"string",
            "description":"The dynamic choice list attribute of the parent feed configuration.",
            "nullable":true
        },
        "DefaultSort":{
            "maxLength":100,
            "type":"string",
            "description":"This field contains the default attribute that will be used for sorting the feed object.",
            "nullable":true
        },
        "RestResource":{
            "maxLength":600,
            "type":"string",
            "description":"This field stores the rest resource url for the feed object.",
            "nullable":true
        },
        "FeedObjectKind":{
            "title":"Feed Object Type",
            "maxLength":20,
            "type":"string",
            "description":"The object type of the feed, which could be a child object or a dynamic choice list.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FeedEvent":{
            "title":"Feed  Events",
            "type":"array",
            "description":"The feed events resource is used to create, update, and delete the events of the feed objects.",
            "items":{
                "$ref":"#/components/schemas/feedConfigurations-FeedObject-FeedEvent-item-patch-request"
            }
        },
        "FeedSupportedAttributes":{
            "title":"Feed Supported Attributes",
            "type":"array",
            "description":"The feed attributes LOV resource is used to view the LOVs for feed attributes.",
            "items":{
                "$ref":"#/components/schemas/feedConfigurations-FeedObject-FeedSupportedAttributes-item-patch-request"
            }
        },
        "FeedObjectDetails":{
            "title":"Feed Object Details",
            "type":"string",
            "description":"This CLOB field contains the additional information of JSON.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "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-FeedAttr-item-patch-request"
            }
        }
    }
}

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

タイプ: 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-FeedAttr-item-patch-request"
    }
}

ネストされたスキーマ : フィード・イベント

タイプ: array

タイトル: Feed Events

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

ソースを表示

• Array of: object schema

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

ネストされたスキーマ : フィードでサポートされている属性

タイプ: array

タイトル: Feed Supported Attributes

フィード属性LOVリソースは、フィード属性の値リストを表示するために使用されます。

ソースを表示

• Array of: object feedConfigurations-FeedObject-FeedSupportedAttributes-item-patch-request

{
    "title":"Feed Supported Attributes",
    "type":"array",
    "description":"The feed attributes LOV resource is used to view the LOVs for feed attributes.",
    "items":{
        "$ref":"#/components/schemas/feedConfigurations-FeedObject-FeedSupportedAttributes-item-patch-request"
    }
}

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

タイプ: object

ソースを表示

• ChangeIndicatorFlag: boolean
  タイトル: Change Indicator

  最大長: 1

  デフォルト値: false

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

  デフォルト値: true

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

  JSONの追加情報を含むCLOB。
• PayloadFlag: boolean
  タイトル: Payload Indicator

  最大長: 1

  デフォルト値: true

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

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

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "PayloadFlag":{
            "title":"Payload Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The JSON-formatted text of the web service.",
            "nullable":false,
            "default":true
        }
    }
}

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

タイプ: object

ソースを表示

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

  最大長: 1

  デフォルト値: true

  フィードを生成するためのイベントのステータス。
• FeedAttr: array Feed Attributes
  タイトル: Feed Attributes

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

  「このCLOB」フィールドには、JSONの追加情報が含まれます。

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active Status Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The status of the event for generating the feed.",
            "nullable":false,
            "default":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-patch-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 feedConfigurations-FeedObject-FeedEvent-FeedAttr-item-patch-request

{
    "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-patch-request"
    }
}

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

タイプ: object

ソースを表示

• ChangeIndicatorFlag: boolean
  タイトル: Change Indicator

  最大長: 1

  デフォルト値: false

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

  デフォルト値: true

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

  JSONの追加情報を含むCLOB。
• PayloadFlag: boolean
  タイトル: Payload Indicator

  最大長: 1

  デフォルト値: true

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

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

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "PayloadFlag":{
            "title":"Payload Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The JSON-formatted text of the web service.",
            "nullable":false,
            "default":true
        }
    }
}

ネストされたスキーマ : feedConfigurations-FeedObject-FeedSupportedAttributes-item-patch-request

タイプ: object

ソースを表示

{
    "type":"object",
    "properties":{
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  レコードが作成された日付。
• DefaultSort: string
  最大長: 100

  このフィールドには、フィード・オブジェクトのソートに使用されるデフォルト属性が含まれます。
• DeleteFlag: boolean
  読取り専用: true

  最大長: 1

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

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

  フィード・イベント・リソースは、フィード・オブジェクトのイベントを作成、更新および削除するために使用されます。
• FeedId: string
  タイトル: Feed ID

  最大長: 64

  フィードの一意の識別子。
• FeedObjectDetails: 文字列(バイト)
  タイトル: Feed Object Details

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

  最大長: 64

  フィード・オブジェクトの一意の識別子。
• FeedObjectKind: string
  タイトル: Feed Object Type

  最大長: 20

  フィードのオブジェクト・タイプ。子オブジェクトまたは動的選択リストです。
• FeedSupportedAttributes: array Feed Supported Attributes
  タイトル: Feed Supported Attributes

  フィード属性LOVリソースは、フィード属性の値リストを表示するために使用されます。
• 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
  タイトル: Object Name

  最大長: 128

  フィードが作成されるオブジェクトの名前。
• ParentFeedObjectId: string
  タイトル: Parent Feed Object ID

  最大長: 64

  親オブジェクトのフィード識別子を決定します。
• RestResource: string
  最大長: 600

  このフィールドには、フィード・オブジェクトの残りのリソースURLが格納されます。
• SourceAttribute: string
  タイトル: Source Attribute

  最大長: 100

  親フィード構成の動的選択リスト属性。
• 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
        },
        "DefaultSort":{
            "maxLength":100,
            "type":"string",
            "description":"This field contains the default attribute that will be used for sorting the feed object.",
            "nullable":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
        },
        "ParentFeedObjectId":{
            "title":"Parent Feed Object ID",
            "maxLength":64,
            "type":"string",
            "description":"Determines the feed identifier of the parent object.",
            "nullable":true,
            "x-queryable":true
        },
        "RestResource":{
            "maxLength":600,
            "type":"string",
            "description":"This field stores the rest resource url for the feed object.",
            "nullable":true,
            "x-queryable":true
        },
        "FeedSupportedAttributes":{
            "title":"Feed Supported Attributes",
            "type":"array",
            "description":"The feed attributes LOV resource is used to view the LOVs for feed attributes.",
            "items":{
                "$ref":"#/components/schemas/feedConfigurations-FeedObject-FeedSupportedAttributes-item-response"
            }
        },
        "FeedId":{
            "title":"Feed ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the feed.",
            "nullable":false,
            "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
        },
        "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-FeedAttr-item-response"
            }
        },
        "ObjectName":{
            "title":"Object Name",
            "maxLength":128,
            "type":"string",
            "description":"The name of the object for which the feed is being created.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceAttribute":{
            "title":"Source Attribute",
            "maxLength":100,
            "type":"string",
            "description":"The dynamic choice list attribute of the parent feed configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FeedObjectKind":{
            "title":"Feed Object Type",
            "maxLength":20,
            "type":"string",
            "description":"The object type of the feed, which could be a child object or a dynamic choice list.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FeedEvent":{
            "title":"Feed  Events",
            "type":"array",
            "description":"The feed events resource is used to create, update, and delete the events of the feed objects.",
            "items":{
                "$ref":"#/components/schemas/feedConfigurations-FeedObject-FeedEvent-item-response"
            }
        },
        "FeedObjectId":{
            "title":"Feed Object ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of 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"
            }
        },
        "FeedObjectDetails":{
            "title":"Feed Object Details",
            "type":"string",
            "description":"This CLOB field contains the additional information of JSON.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "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-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-FeedAttr-item-response"
    }
}

ネストされたスキーマ : フィード・イベント

タイプ: array

タイトル: Feed Events

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

ソースを表示

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

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

ネストされたスキーマ : フィードでサポートされている属性

タイプ: array

タイトル: Feed Supported Attributes

フィード属性LOVリソースは、フィード属性の値リストを表示するために使用されます。

ソースを表示

• Array of: object feedConfigurations-FeedObject-FeedSupportedAttributes-item-response

{
    "title":"Feed Supported Attributes",
    "type":"array",
    "description":"The feed attributes LOV resource is used to view the LOVs for feed attributes.",
    "items":{
        "$ref":"#/components/schemas/feedConfigurations-FeedObject-FeedSupportedAttributes-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-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."
        }
    }
}

ネストされたスキーマ : 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"
    }
}

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

タイプ: object

ソースを表示

• AttributeName: string
  タイトル: Attribute Name

  読取り専用: true

  最大長: 255

  属性の名前。
• ChangeIndicatorFlag: boolean
  タイトル: Change Indicator

  読取り専用: true

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

  読取り専用: true

  最大長: 255

  フィードの一意の識別子。
• FeedObj: string
  タイトル: Feed Object

  読取り専用: true

  最大長: 255

  サポートされている属性に関連付けられたフィード・オブジェクト。
• FeedObjectId: string
  タイトル: Feed Object ID

  読取り専用: true

  最大長: 255

  フィード・オブジェクトの一意の識別子。
• FeedType: string
  タイトル: Feed Type

  読取り専用: true

  最大長: 255

  フィードの保持中のフィードのタイプ。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MandatoryForFeedFlag: boolean
  タイトル: Mandatory for Feed

  読取り専用: true

  属性は、フィールドがフィードに必須かどうかを示します。
• RelatedObj: string
  タイトル: Related Object

  読取り専用: true

  最大長: 255

  属性が定義されているフィード・オブジェクト。
• Title: string
  タイトル: Feed Title

  読取り専用: true

  最大長: 255

  フィード・オブジェクトの表示ラベル(リード・フィード・タイプの営業リードなど)。

{
    "type":"object",
    "properties":{
        "FeedObj":{
            "title":"Feed Object",
            "maxLength":255,
            "type":"string",
            "description":"The feed object associated with the supported attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeedType":{
            "title":"Feed Type",
            "maxLength":255,
            "type":"string",
            "description":"The type of feed while persisting the feed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeedId":{
            "title":"Feed ID",
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the feed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeIndicatorFlag":{
            "title":"Change Indicator",
            "type":"boolean",
            "description":"The change indicator that denotes when an attribute is updated and the signal is generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FeedObjectId":{
            "title":"Feed Object ID",
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier for feed object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Feed Title",
            "maxLength":255,
            "type":"string",
            "description":"The display label for the feed object, such as Sales Lead for Lead feed type.",
            "nullable":true,
            "readOnly":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":255,
            "type":"string",
            "description":"The name of the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MandatoryForFeedFlag":{
            "title":"Mandatory for Feed",
            "type":"boolean",
            "description":"The attribute denotes whether the field is mandatory for feed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedObj":{
            "title":"Related Object",
            "maxLength":255,
            "type":"string",
            "description":"The feed object for which the attribute is being defined.",
            "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"
    }
}

リンク

FeedAttr

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

パラメータ:

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

(FeedAttrのリソース)

FeedEvent

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

パラメータ:

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

(FeedEventのリソース)

FeedSupportedAttributes

操作: /crmRestApi/resources/11.13.18.05/feedConfigurations/{FeedId}/child/FeedObject/{FeedObjectId}/child/FeedSupportedAttributes

パラメータ:

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

(FeedSupportedAttributesのリソース)

「トップに戻る」