Jump to

• Request
• Response

Update a feed attribute

patch

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

Request

Path Parameters

• FeedAttributeId(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• FeedEventId(required): string
  The unique identifier of the feed event.
• FeedId(required): string
  The unique identifier of the feed.
• FeedObjectId(required): string
  The unique identifier of feed object.

Header Parameters

• Metadata-Context: string
  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: string
  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

• 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
        },
        "DisplayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicates if the field is an internal attribute",
            "nullable":true,
            "default":true
        },
        "FeedAttrDetails":{
            "title":"Feed Attribute Details",
            "type":"string",
            "description":"The CLOB that contains additional information of JSON.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PayloadFlag":{
            "title":"Payload Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"The JSON-formatted text of the web service.",
            "nullable":false,
            "default":true
        },
        "SortFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicates if the field can be sorted.",
            "nullable":true
        }
    }
}

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-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":{
        "AttributeName":{
            "title":"Attribute Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the attribute of the feed object.",
            "nullable":false,
            "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created 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
        },
        "DeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":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
        },
        "FeedAttrDetails":{
            "title":"Feed Attribute Details",
            "type":"string",
            "description":"The CLOB that contains additional information of JSON.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FeedAttributeId":{
            "title":"Feed Attribute ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier for attribute of the feed object.",
            "nullable":false,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated 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
        },
        "SortFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"The flag indicates if the field can be sorted.",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Back to Top