Jump to

• Request
• Response

Update a feed object

patch

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

Request

Path Parameters

• FeedId(required): string
  The unique identifier of the feed.
• FeedObjectId(required): string
  The unique identifier of feed object.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Status Indicator

  Maximum Length: 1

  The status of the object for generating the feed.
• DefaultSort: string
  Maximum Length: 100

  This field contains the default attribute that will be used for sorting the feed object.
• FeedAttr: array Feed Attributes
  Title: Feed Attributes

  The feed attributes resource is used to create, update, and delete the attributes of the feed objects.
• FeedEvent: array Feed Events
  Title: Feed Events

  The feed events resource is used to create, update, and delete the events of the feed objects.
• FeedObjectDetails: string (byte)
  Title: Feed Object Details

  This CLOB field contains the additional information of JSON.
• FeedObjectKind: string
  Title: Feed Object Type

  Maximum Length: 20

  The object type of the feed, which could be a child object or a dynamic choice list.
• FeedSupportedAttributes: array Feed Supported Attributes
  Title: Feed Supported Attributes

  The feed attributes LOV resource is used to view the LOVs for feed attributes.
• RestResource: string
  Maximum Length: 600

  This field stores the rest resource url for the feed object.
• SourceAttribute: string
  Title: Source Attribute

  Maximum Length: 100

  The dynamic choice list attribute of the parent feed configuration.

{
    "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
        },
        "ActiveFlag":{
            "title":"Active Status Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"The status of the object for generating the feed.",
            "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"
            }
        }
    }
}

Nested Schema : Feed Attributes

Type: array

Title: Feed Attributes

The feed attributes resource is used to create, update, and delete the attributes of the feed objects.

Show Source

• 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"
    }
}

Nested Schema : Feed Events

Type: array

Title: Feed Events

The feed events resource is used to create, update, and delete the events of the feed objects.

Show Source

• 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"
    }
}

Nested Schema : Feed Supported Attributes

Type: array

Title: Feed Supported Attributes

The feed attributes LOV resource is used to view the LOVs for feed attributes.

Show Source

• 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"
    }
}

Nested Schema : schema

Type: object

Show Source

• ChangeIndicatorFlag: boolean
  Title: Change Indicator

  Maximum Length: 1

  Default Value: false

  The change indicator that denotes when an attribute is updated and the signal is generated.
• DisplayFlag: boolean
  Maximum Length: 1

  Default Value: true

  The flag indicates if the field is an internal attribute
• FeedAttrDetails: string (byte)
  Title: Feed Attribute Details

  The CLOB that contains additional information of JSON.
• PayloadFlag: boolean
  Title: Payload Indicator

  Maximum Length: 1

  Default Value: true

  The JSON-formatted text of the web service.
• SortFlag: boolean
  Maximum Length: 1

  The flag indicates if the field can be sorted.

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

Nested Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Status Indicator

  Maximum Length: 1

  Default Value: true

  The status of the event for generating the feed.
• FeedAttr: array Feed Attributes
  Title: Feed Attributes

  The feed attributes resource is used to create, update, and delete the attributes of the feed objects.
• FeedEventDetails: string (byte)
  Title: Feed Event Details

  This CLOB field contains additional information of 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
        }
    }
}

Nested Schema : Feed Attributes

Type: array

Title: Feed Attributes

The feed attributes resource is used to create, update, and delete the attributes of the feed objects.

Show Source

• 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"
    }
}

Nested Schema : feedConfigurations-FeedObject-FeedEvent-FeedAttr-item-patch-request

Type: object

Show Source

• ChangeIndicatorFlag: boolean
  Title: Change Indicator

  Maximum Length: 1

  Default Value: false

  The change indicator that denotes when an attribute is updated and the signal is generated.
• DisplayFlag: boolean
  Maximum Length: 1

  Default Value: true

  The flag indicates if the field is an internal attribute
• FeedAttrDetails: string (byte)
  Title: Feed Attribute Details

  The CLOB that contains additional information of JSON.
• PayloadFlag: boolean
  Title: Payload Indicator

  Maximum Length: 1

  Default Value: true

  The JSON-formatted text of the web service.
• SortFlag: boolean
  Maximum Length: 1

  The flag indicates if the field can be sorted.

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

Nested Schema : feedConfigurations-FeedObject-FeedSupportedAttributes-item-patch-request

Type: object

Show Source

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

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : feedConfigurations-FeedObject-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Status Indicator

  Maximum Length: 1

  The status of the object for generating the feed.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DefaultSort: string
  Maximum Length: 100

  This field contains the default attribute that will be used for sorting the feed object.
• DeleteFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the user has access to delete the record.
• FeedAttr: array Feed Attributes
  Title: Feed Attributes

  The feed attributes resource is used to create, update, and delete the attributes of the feed objects.
• FeedEvent: array Feed Events
  Title: Feed Events

  The feed events resource is used to create, update, and delete the events of the feed objects.
• FeedId: string
  Title: Feed ID

  Maximum Length: 64

  The unique identifier of the feed.
• FeedObjectDetails: string (byte)
  Title: Feed Object Details

  This CLOB field contains the additional information of JSON.
• FeedObjectId: string
  Title: Feed Object ID

  Maximum Length: 64

  The unique identifier of feed object.
• FeedObjectKind: string
  Title: Feed Object Type

  Maximum Length: 20

  The object type of the feed, which could be a child object or a dynamic choice list.
• FeedSupportedAttributes: array Feed Supported Attributes
  Title: Feed Supported Attributes

  The feed attributes LOV resource is used to view the LOVs for feed attributes.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectName: string
  Title: Object Name

  Maximum Length: 128

  The name of the object for which the feed is being created.
• ParentFeedObjectId: string
  Title: Parent Feed Object ID

  Maximum Length: 64

  Determines the feed identifier of the parent object.
• RestResource: string
  Maximum Length: 600

  This field stores the rest resource url for the feed object.
• SourceAttribute: string
  Title: Source Attribute

  Maximum Length: 100

  The dynamic choice list attribute of the parent feed configuration.
• UpdateFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the user has access to update the record.

{
    "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
        },
        "ActiveFlag":{
            "title":"Active Status Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"The status of the object for generating the feed.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        }
    }
}

Nested Schema : Feed Attributes

Type: array

Title: Feed Attributes

The feed attributes resource is used to create, update, and delete the attributes of the feed objects.

Show Source

• 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"
    }
}

Nested Schema : Feed Events

Type: array

Title: Feed Events

The feed events resource is used to create, update, and delete the events of the feed objects.

Show Source

• 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"
    }
}

Nested Schema : Feed Supported Attributes

Type: array

Title: Feed Supported Attributes

The feed attributes LOV resource is used to view the LOVs for feed attributes.

Show Source

• 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"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : feedConfigurations-FeedObject-FeedAttr-item-response

Type: object

Show Source

• AttributeName: string
  Title: Attribute Name

  Maximum Length: 100

  The name of the attribute of the feed object.
• ChangeIndicatorFlag: boolean
  Title: Change Indicator

  Maximum Length: 1

  Default Value: false

  The change indicator that denotes when an attribute is updated and the signal is generated.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DeleteFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the user has access to delete the record.
• DisplayFlag: boolean
  Maximum Length: 1

  Default Value: true

  The flag indicates if the field is an internal attribute
• FeedAttrDetails: string (byte)
  Title: Feed Attribute Details

  The CLOB that contains additional information of JSON.
• FeedAttributeId: string
  Title: Feed Attribute ID

  Maximum Length: 64

  The unique identifier for attribute of the feed object.
• FeedEventId: string
  Title: Feed Event ID

  Maximum Length: 64

  The name of the attribute of the feed object.
• FeedObjectId: string
  Title: Feed Object ID

  Maximum Length: 64

  The unique identifier for feed object.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayloadFlag: boolean
  Title: Payload Indicator

  Maximum Length: 1

  Default Value: true

  The JSON-formatted text of the web service.
• SortFlag: boolean
  Maximum Length: 1

  The flag indicates if the field can be sorted.
• UpdateFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the user has access to update the record.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

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

Nested Schema : feedConfigurations-FeedObject-FeedEvent-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Status Indicator

  Maximum Length: 1

  Default Value: true

  The status of the event for generating the feed.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DeleteFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the user has access to delete the record.
• EventCode: string
  Title: Event Code

  Maximum Length: 30

  The type of event for which the feed needs to be generated.
• FeedAttr: array Feed Attributes
  Title: Feed Attributes

  The feed attributes resource is used to create, update, and delete the attributes of the feed objects.
• FeedEventDetails: string (byte)
  Title: Feed Event Details

  This CLOB field contains additional information of JSON.
• FeedEventId: string
  Title: Feed Event ID

  Maximum Length: 64

  The unique identifier of the feed event.
• FeedObjectId: string
  Title: Feed Object ID

  Maximum Length: 64

  The unique identifier of the feed object.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SignalDefId: string
  Title: Signal Definition ID

  Maximum Length: 64

  The identifier for signal definition that is generated by signals.
• UpdateFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the user has access to update the record.

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

Nested Schema : Feed Attributes

Type: array

Title: Feed Attributes

The feed attributes resource is used to create, update, and delete the attributes of the feed objects.

Show Source

• 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"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : feedConfigurations-FeedObject-FeedEvent-FeedAttr-item-response

Type: object

Show Source

• AttributeName: string
  Title: Attribute Name

  Maximum Length: 100

  The name of the attribute of the feed object.
• ChangeIndicatorFlag: boolean
  Title: Change Indicator

  Maximum Length: 1

  Default Value: false

  The change indicator that denotes when an attribute is updated and the signal is generated.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DeleteFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the user has access to delete the record.
• DisplayFlag: boolean
  Maximum Length: 1

  Default Value: true

  The flag indicates if the field is an internal attribute
• FeedAttrDetails: string (byte)
  Title: Feed Attribute Details

  The CLOB that contains additional information of JSON.
• FeedAttributeId: string
  Title: Feed Attribute ID

  Maximum Length: 64

  The unique identifier for attribute of the feed object.
• FeedEventId: string
  Title: Feed Event ID

  Maximum Length: 64

  The name of the attribute of the feed object.
• FeedObjectId: string
  Title: Feed Object ID

  Maximum Length: 64

  The unique identifier for feed object.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayloadFlag: boolean
  Title: Payload Indicator

  Maximum Length: 1

  Default Value: true

  The JSON-formatted text of the web service.
• SortFlag: boolean
  Maximum Length: 1

  The flag indicates if the field can be sorted.
• UpdateFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the user has access to update the record.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : feedConfigurations-FeedObject-FeedSupportedAttributes-item-response

Type: object

Show Source

• AttributeName: string
  Title: Attribute Name

  Read Only: true

  Maximum Length: 255

  The name of the attribute.
• ChangeIndicatorFlag: boolean
  Title: Change Indicator

  Read Only: true

  The change indicator that denotes when an attribute is updated and the signal is generated.
• FeedId: string
  Title: Feed ID

  Read Only: true

  Maximum Length: 255

  The unique identifier of the feed.
• FeedObj: string
  Title: Feed Object

  Read Only: true

  Maximum Length: 255

  The feed object associated with the supported attribute.
• FeedObjectId: string
  Title: Feed Object ID

  Read Only: true

  Maximum Length: 255

  The unique identifier for feed object.
• FeedType: string
  Title: Feed Type

  Read Only: true

  Maximum Length: 255

  The type of feed while persisting the feed.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryForFeedFlag: boolean
  Title: Mandatory for Feed

  Read Only: true

  The attribute denotes whether the field is mandatory for feed.
• RelatedObj: string
  Title: Related Object

  Read Only: true

  Maximum Length: 255

  The feed object for which the attribute is being defined.
• Title: string
  Title: Feed Title

  Read Only: true

  Maximum Length: 255

  The display label for the feed object, such as Sales Lead for Lead feed type.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Links

FeedAttr

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

Parameters:

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

The feed attributes resource is used to create, update, and delete the attributes of the feed objects.

FeedEvent

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

Parameters:

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

The feed events resource is used to create, update, and delete the events of the feed objects.

FeedSupportedAttributes

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

Parameters:

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

The feed attributes LOV resource is used to view the LOVs for feed attributes.

Back to Top