Jump to

• Request
• Response

Update a notification

patch

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

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorNotificationsUniqID: integer
  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>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorNotifications-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the notification.
• Body(optional): string
  The notification message body text.
• ChannelType(optional): string
  Maximum Length: 30

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

  The date and time that the notification was created.
• FromAddress(optional): string
  Maximum Length: 256

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

  The date that the notification was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• LogMessageId(optional): integer(int64)
  The unique identifier of the log message. This ID is generated automatically by the application.
• LogRecipientId(optional): integer(int64)
  The unique identifier of the log recipient. This ID is generated automatically by the application.
• MessageDeleteAllowed(optional): boolean
  Indicates whether the notification can be deleted from a user's notification list.
• MessageSeq(optional): integer(int64)
  The message sequence number.
• MimeType(optional): string
  Maximum Length: 30

  The MIME type of communication message. The possible values are HTML and Text.
• Priority(optional): string
  Maximum Length: 1

  The priority of the notification.
• SentOn(optional): string(date-time)
  The date and time of the notification.
• SentTo(optional): string
  Maximum Length: 1500

  The user ID of the notification recipient.
• Status(optional): string
  Maximum Length: 30

  The status of the communication message.
• StatusMeaning(optional): string
  Maximum Length: 80

  The status of the notification message.
• Subject(optional): string
  Maximum Length: 1000

  The subject of the notification message.
• TemplateId(optional): integer(int64)
  The unique identifier of the communication template associated with the notification.
• Visibility(optional): string
  Maximum Length: 30

  The visibility option of the notification.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The unique identifier of the agency associated with the notification.",
            "type":"integer",
            "format":"int32"
        },
        "Body":{
            "description":"The notification message body text.",
            "type":"string"
        },
        "ChannelType":{
            "description":"The channel type of the communication message.",
            "type":"string",
            "maxLength":30
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time that  the notification was created.",
            "type":"string",
            "format":"date-time"
        },
        "FromAddress":{
            "description":"The sender of the notification message.",
            "type":"string",
            "maxLength":256
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date that the notification was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LogMessageId":{
            "description":"The unique identifier of the log message. This ID is generated automatically by the application.",
            "type":"integer",
            "format":"int64"
        },
        "LogRecipientId":{
            "description":"The unique identifier of the log recipient. This ID is generated automatically by the application.",
            "type":"integer",
            "format":"int64"
        },
        "MessageDeleteAllowed":{
            "description":"Indicates whether the notification can be deleted from a user's notification list.",
            "type":"boolean"
        },
        "MessageSeq":{
            "description":"The message sequence number.",
            "type":"integer",
            "format":"int64"
        },
        "MimeType":{
            "description":"The MIME type of communication message. The possible values are HTML and Text.",
            "type":"string",
            "maxLength":30
        },
        "Priority":{
            "description":"The priority of the notification.",
            "type":"string",
            "maxLength":1
        },
        "SentOn":{
            "description":"The date and time of the notification.",
            "type":"string",
            "format":"date-time"
        },
        "SentTo":{
            "description":"The user ID of the notification recipient.",
            "type":"string",
            "maxLength":1500
        },
        "Status":{
            "description":"The status of the communication message.",
            "type":"string",
            "maxLength":30
        },
        "StatusMeaning":{
            "description":"The status of the notification message.",
            "type":"string",
            "maxLength":80
        },
        "Subject":{
            "description":"The subject of the notification message.",
            "type":"string",
            "maxLength":1000
        },
        "TemplateId":{
            "description":"The unique identifier of the communication template associated with the notification.",
            "type":"integer",
            "format":"int64"
        },
        "Visibility":{
            "description":"The visibility option of the notification.",
            "type":"string",
            "maxLength":30
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorNotifications-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the notification.
• Body(optional): string
  The notification message body text.
• ChannelType(optional): string
  Maximum Length: 30

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

  The date and time that the notification was created.
• FromAddress(optional): string
  Maximum Length: 256

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

  The date that the notification was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• LogMessageId(optional): integer(int64)
  The unique identifier of the log message. This ID is generated automatically by the application.
• LogRecipientId(optional): integer(int64)
  The unique identifier of the log recipient. This ID is generated automatically by the application.
• MessageDeleteAllowed(optional): boolean
  Indicates whether the notification can be deleted from a user's notification list.
• MessageSeq(optional): integer(int64)
  The message sequence number.
• MimeType(optional): string
  Maximum Length: 30

  The MIME type of communication message. The possible values are HTML and Text.
• Priority(optional): string
  Maximum Length: 1

  The priority of the notification.
• SentOn(optional): string(date-time)
  The date and time of the notification.
• SentTo(optional): string
  Maximum Length: 1500

  The user ID of the notification recipient.
• Status(optional): string
  Maximum Length: 30

  The status of the communication message.
• StatusMeaning(optional): string
  Maximum Length: 80

  The status of the notification message.
• Subject(optional): string
  Maximum Length: 1000

  The subject of the notification message.
• TemplateId(optional): integer(int64)
  The unique identifier of the communication template associated with the notification.
• Visibility(optional): string
  Maximum Length: 30

  The visibility option of the notification.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "description":"The unique identifier of the agency associated with the notification.",
            "type":"integer",
            "format":"int32"
        },
        "Body":{
            "description":"The notification message body text.",
            "type":"string"
        },
        "ChannelType":{
            "description":"The channel type of the communication message.",
            "type":"string",
            "maxLength":30
        },
        "CreationDate":{
            "title":"Creation Date",
            "description":"The date and time that  the notification was created.",
            "type":"string",
            "format":"date-time"
        },
        "FromAddress":{
            "description":"The sender of the notification message.",
            "type":"string",
            "maxLength":256
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "description":"The date that the notification was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "LogMessageId":{
            "description":"The unique identifier of the log message. This ID is generated automatically by the application.",
            "type":"integer",
            "format":"int64"
        },
        "LogRecipientId":{
            "description":"The unique identifier of the log recipient. This ID is generated automatically by the application.",
            "type":"integer",
            "format":"int64"
        },
        "MessageDeleteAllowed":{
            "description":"Indicates whether the notification can be deleted from a user's notification list.",
            "type":"boolean"
        },
        "MessageSeq":{
            "description":"The message sequence number.",
            "type":"integer",
            "format":"int64"
        },
        "MimeType":{
            "description":"The MIME type of communication message. The possible values are HTML and Text.",
            "type":"string",
            "maxLength":30
        },
        "Priority":{
            "description":"The priority of the notification.",
            "type":"string",
            "maxLength":1
        },
        "SentOn":{
            "description":"The date and time of the notification.",
            "type":"string",
            "format":"date-time"
        },
        "SentTo":{
            "description":"The user ID of the notification recipient.",
            "type":"string",
            "maxLength":1500
        },
        "Status":{
            "description":"The status of the communication message.",
            "type":"string",
            "maxLength":30
        },
        "StatusMeaning":{
            "description":"The status of the notification message.",
            "type":"string",
            "maxLength":80
        },
        "Subject":{
            "description":"The subject of the notification message.",
            "type":"string",
            "maxLength":1000
        },
        "TemplateId":{
            "description":"The unique identifier of the communication template associated with the notification.",
            "type":"integer",
            "format":"int64"
        },
        "Visibility":{
            "description":"The visibility option of the notification.",
            "type":"string",
            "maxLength":30
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top