Jump to

• Request
• Response

Update a sender priority sequence

patch

/crmRestApi/resources/11.13.18.05/channels/{ChannelId}/child/senderIdentificationPriorities/{PrioritySequenceId}

Request

Path Parameters

• ChannelId(required): integer(int64)
  The unique identifier of the channel.
• PrioritySequenceId(required): integer(int64)
  The unique identifier of the sender priority sequence.

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

• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel associated with the sender priority sequeuce.
• LookupType: string
  Title: Lookup Type

  Maximum Length: 30

  The type of sender of a message such as Business Contact, Consumer, or Employee.
• PrioritySequence: integer (int64)
  Title: Priority Sequence

  The priority sequence of the sender type.
• PrioritySequenceId: integer (int64)
  Title: Priority Sequence ID

  The unique identifier of the sender priority sequence.

{
    "type":"object",
    "properties":{
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel associated with the sender priority sequeuce.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "ExtnEventActionProperty":"HideInFieldUpdate"
            }
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of sender of a message such as Business Contact, Consumer, or Employee.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrioritySequence":{
            "title":"Priority Sequence",
            "type":"integer",
            "description":"The priority sequence of the sender type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PrioritySequenceId":{
            "title":"Priority Sequence ID",
            "type":"integer",
            "description":"The unique identifier of the sender priority sequence.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "ExtnEventActionProperty":"HideInFieldUpdate"
            }
        }
    }
}

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 : channels-senderIdentificationPriorities-item-response

Type: object

Show Source

• ChannelId: integer (int64)
  Title: Channel ID

  The unique identifier of the channel associated with the sender priority sequeuce.
• 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.
• 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.
• LookupType: string
  Title: Lookup Type

  Maximum Length: 30

  The type of sender of a message such as Business Contact, Consumer, or Employee.
• PrioritySequence: integer (int64)
  Title: Priority Sequence

  The priority sequence of the sender type.
• PrioritySequenceId: integer (int64)
  Title: Priority Sequence ID

  The unique identifier of the sender priority sequence.

{
    "type":"object",
    "properties":{
        "ChannelId":{
            "title":"Channel ID",
            "type":"integer",
            "description":"The unique identifier of the channel associated with the sender priority sequeuce.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "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-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "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-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "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-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "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-hints":{
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of sender of a message such as Business Contact, Consumer, or Employee.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrioritySequence":{
            "title":"Priority Sequence",
            "type":"integer",
            "description":"The priority sequence of the sender type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrioritySequenceId":{
            "title":"Priority Sequence ID",
            "type":"integer",
            "description":"The unique identifier of the sender priority sequence.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "ExtnEventActionProperty":"HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "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."
        }
    }
}

Links

LookupTypeLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_SENDER_RECIPIENT_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: LookupType; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top