Jump to

• Request
• Response

Update an ad hoc alert

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts/{LogId}

Request

Supported Media Types

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

Path Parameters

• LogId: integer
  A logical identifier for the ad hoc alert. This ID is automatically generated by the application.

Body ()

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

Root Schema : publicSectorAdhocAlerts-item

Type: object

Show Source

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

  The unique identifier of the agency associated with the ad hoc alert.
• Alertbody(optional): string
  Title: Body

  Maximum Length: 1000

  The message body of the ad hoc alert.
• AlertEnd(optional): string(date-time)
  Title: Alert End Date

  The date and time when the ad hoc alert is no longer active.
• AlertStart(optional): string(date-time)
  Title: Alert Start Date

  The date and time when the ad hoc alert becomes active.
• Comments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments entered by staff while creating the ad hoc alert.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the ad hoc alert.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the ad hoc alert was created.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the ad hoc alert is available to be used. The default value is N.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the ad hoc alert was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who updated the ad hoc alert most recently.
• links(optional): array Items
  Title: Items

  Link Relations
• LogId(optional): integer(int64)
  Title: Log ID

  A logical identifier for the ad hoc alert. This ID is automatically generated by the application.
• RecordIdentifier(optional): string
  Title: Record Identifier

  Maximum Length: 100

  The unique identifier of the ad hoc alert.
• Status(optional): string
  Title: Status

  Maximum Length: 30

  Status of the ad hoc alert.
• Subject(optional): string
  Title: Subject

  The summary of the ad hoc alert message body.
• ToAddress(optional): string
  Title: Sent To

  Maximum Length: 1000

  The type of the recipient for the ad hoc alert. Possibe values are Registred Users, Anonymous Users, and Specified Users.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the ad hoc alert.",
            "title":"Agency ID"
        },
        "AlertEnd":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the ad hoc alert is no longer active.",
            "title":"Alert End Date"
        },
        "AlertStart":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the ad hoc alert becomes active.",
            "title":"Alert Start Date"
        },
        "Alertbody":{
            "maxLength":1000,
            "type":"string",
            "description":"The message body of the ad hoc alert.",
            "title":"Body"
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments entered by staff while creating the ad hoc alert.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The  user who created the ad hoc alert.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the ad hoc alert was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the ad hoc alert is available to be used. The default value is N.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the ad hoc alert was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the ad hoc alert most recently.",
            "title":"Last Updated By"
        },
        "LogId":{
            "format":"int64",
            "type":"integer",
            "description":"A logical identifier for the ad hoc alert. This ID is automatically generated by the application.",
            "title":"Log ID"
        },
        "RecordIdentifier":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the ad hoc alert.",
            "title":"Record Identifier"
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the ad hoc alert.",
            "title":"Status"
        },
        "Subject":{
            "type":"string",
            "description":"The summary of the ad hoc alert message body.",
            "title":"Subject"
        },
        "ToAddress":{
            "maxLength":1000,
            "type":"string",
            "description":"The type of the recipient for the ad hoc alert. Possibe values are Registred Users, Anonymous Users, and Specified Users.",
            "title":"Sent To"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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 : publicSectorAdhocAlerts-item

Type: object

Show Source

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

  The unique identifier of the agency associated with the ad hoc alert.
• Alertbody(optional): string
  Title: Body

  Maximum Length: 1000

  The message body of the ad hoc alert.
• AlertEnd(optional): string(date-time)
  Title: Alert End Date

  The date and time when the ad hoc alert is no longer active.
• AlertStart(optional): string(date-time)
  Title: Alert Start Date

  The date and time when the ad hoc alert becomes active.
• Comments(optional): string
  Title: Comments

  Maximum Length: 1000

  The comments entered by staff while creating the ad hoc alert.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the ad hoc alert.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the ad hoc alert was created.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the ad hoc alert is available to be used. The default value is N.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date when the ad hoc alert was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who updated the ad hoc alert most recently.
• links(optional): array Items
  Title: Items

  Link Relations
• LogId(optional): integer(int64)
  Title: Log ID

  A logical identifier for the ad hoc alert. This ID is automatically generated by the application.
• RecordIdentifier(optional): string
  Title: Record Identifier

  Maximum Length: 100

  The unique identifier of the ad hoc alert.
• Status(optional): string
  Title: Status

  Maximum Length: 30

  Status of the ad hoc alert.
• Subject(optional): string
  Title: Subject

  The summary of the ad hoc alert message body.
• ToAddress(optional): string
  Title: Sent To

  Maximum Length: 1000

  The type of the recipient for the ad hoc alert. Possibe values are Registred Users, Anonymous Users, and Specified Users.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the ad hoc alert.",
            "title":"Agency ID"
        },
        "AlertEnd":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the ad hoc alert is no longer active.",
            "title":"Alert End Date"
        },
        "AlertStart":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the ad hoc alert becomes active.",
            "title":"Alert Start Date"
        },
        "Alertbody":{
            "maxLength":1000,
            "type":"string",
            "description":"The message body of the ad hoc alert.",
            "title":"Body"
        },
        "Comments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments entered by staff while creating the ad hoc alert.",
            "title":"Comments"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The  user who created the ad hoc alert.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the ad hoc alert was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the ad hoc alert is available to be used. The default value is N.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the ad hoc alert was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the ad hoc alert most recently.",
            "title":"Last Updated By"
        },
        "LogId":{
            "format":"int64",
            "type":"integer",
            "description":"A logical identifier for the ad hoc alert. This ID is automatically generated by the application.",
            "title":"Log ID"
        },
        "RecordIdentifier":{
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the ad hoc alert.",
            "title":"Record Identifier"
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the ad hoc alert.",
            "title":"Status"
        },
        "Subject":{
            "type":"string",
            "description":"The summary of the ad hoc alert message body.",
            "title":"Subject"
        },
        "ToAddress":{
            "maxLength":1000,
            "type":"string",
            "description":"The type of the recipient for the ad hoc alert. Possibe values are Registred Users, Anonymous Users, and Specified Users.",
            "title":"Sent To"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top