Jump to

• Request
• Response

Update a notification

patch

/fscmRestApi/resources/11.13.18.05/publicSectorNotifications/{publicSectorNotificationsUniqID}

Request

Path Parameters

• publicSectorNotificationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- LogMessageId and LogRecipientId ---for the Notifications resource and used to uniquely identify an instance of Notifications. The client should not generate the hash key value. Instead, the client should query on the Notifications collection resource with a filter on the primary key values in order to navigate to a specific instance of Notifications.
  
  For example: publicSectorNotifications?q=LogMessageId=<value1>;LogRecipientId=<value2>

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

• Status: string
  Title: Status

  Maximum Length: 30

  The status of the communication message.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the communication message.",
            "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 : publicSectorNotifications-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Read Only: true

  Default Value: 1

  The unique identifier of the agency associated with the notification.
• AttachRowCount: string
  Read Only: true

  The count of attachments for the communication.
• Body: string (byte)
  Title: Body

  Read Only: true

  The notification message body text.
• ChannelType: string
  Title: Channel Type

  Read Only: true

  Maximum Length: 30

  The channel type of the communication message.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time that the notification was created.
• FromAddress: string
  Title: From Address

  Read Only: true

  Maximum Length: 256

  The sender of the notification message.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date that the notification was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LogMessageId: integer (int64)
  Title: Log Message ID

  Read Only: true

  The unique identifier of the log message. This ID is generated automatically by the application.
• LogRecipientId: integer (int64)
  Title: Log Recipient ID

  Read Only: true

  The unique identifier of the log recipient. This ID is generated automatically by the application.
• MessageDeleteAllowed: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the notification can be deleted from a user's notification list.
• MessageSeq: integer (int64)
  Title: Message Sequence

  Read Only: true

  The message sequence number.
• MimeType: string
  Title: MIME Type

  Read Only: true

  Maximum Length: 30

  The MIME type of communication message. The possible values are HTML and Text.
• Priority: string
  Title: Priority

  Read Only: true

  Maximum Length: 1

  The priority of the notification.
• SentOn: string (date-time)
  Title: Sent On

  Read Only: true

  The date and time of the notification.
• SentTo: string
  Title: Sent To

  Read Only: true

  Maximum Length: 1500

  The user ID of the notification recipient.
• Status: string
  Title: Status

  Maximum Length: 30

  The status of the communication message.
• StatusMeaning: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  The status of the notification message.
• Subject: string
  Title: Subject

  Read Only: true

  Maximum Length: 1000

  The subject of the notification message.
• TemplateId: integer (int64)
  Title: Template ID

  Read Only: true

  The unique identifier of the communication template associated with the notification.
• Visibility: string
  Title: Visibility

  Read Only: true

  Maximum Length: 30

  The visibility option of the notification.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the communication message.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that the notification was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the notification.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "maxLength":1,
            "type":"string",
            "description":"The priority of the notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LogRecipientId":{
            "title":"Log Recipient ID",
            "type":"integer",
            "description":"The unique identifier of the log recipient. This ID is generated automatically by the application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AttachRowCount":{
            "type":"string",
            "description":"The count of attachments for the communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LogMessageId":{
            "title":"Log Message ID",
            "type":"integer",
            "description":"The unique identifier of the log message. This ID is generated automatically by the application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MimeType":{
            "title":"MIME Type",
            "maxLength":30,
            "type":"string",
            "description":"The MIME type of communication message. The possible values are HTML and Text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subject":{
            "title":"Subject",
            "maxLength":1000,
            "type":"string",
            "description":"The subject of the notification message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the notification message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SentOn":{
            "title":"Sent On",
            "type":"string",
            "description":"The date and time of the notification.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageSeq":{
            "title":"Message Sequence",
            "type":"integer",
            "description":"The message sequence number.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FromAddress":{
            "title":"From Address",
            "maxLength":256,
            "type":"string",
            "description":"The sender of the notification message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageDeleteAllowed":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the notification can be deleted from a user's notification list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SentTo":{
            "title":"Sent To",
            "maxLength":1500,
            "type":"string",
            "description":"The user ID of the notification recipient.",
            "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"
            }
        },
        "Visibility":{
            "title":"Visibility",
            "maxLength":30,
            "type":"string",
            "description":"The visibility option of the notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelType":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"The channel type of the communication message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Body":{
            "title":"Body",
            "type":"string",
            "description":"The notification message body text.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the communication template associated with the notification.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date that the notification was last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

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