Jump to

• Request
• Response

Create an ad hoc alert

post

/fscmRestApi/resources/11.13.18.05/publicSectorAdhocAlerts

Request

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.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Maximum Length: 1000

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

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

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

  Maximum Length: 1000

  The comments entered by staff while creating the ad hoc alert.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: false

  Indicates whether the ad hoc alert is available to be used. The default value is N.
• LogId: integer (int64)
  Title: Log ID

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

  Maximum Length: 100

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

  Maximum Length: 30

  Status of the ad hoc alert.
• ToAddress: 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.

{
    "type":"object",
    "properties":{
        "RecordIdentifier":{
            "title":"Record Identifier",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the ad hoc alert.",
            "nullable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the ad hoc alert.",
            "nullable":false
        },
        "Alertbody":{
            "title":"Body",
            "maxLength":1000,
            "type":"string",
            "description":"The message body of the ad hoc alert.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the ad hoc alert.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments entered by staff while creating the ad hoc alert.",
            "nullable":true
        },
        "AlertEnd":{
            "title":"Alert End Date",
            "type":"string",
            "description":"The date and time when the ad hoc alert is no longer active.",
            "format":"date-time",
            "nullable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the ad hoc alert is available to be used. The default value is N.",
            "nullable":false,
            "default":false
        },
        "LogId":{
            "title":"Log ID",
            "type":"integer",
            "description":"A logical identifier for the ad hoc alert. This ID is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "AlertStart":{
            "title":"Alert Start Date",
            "type":"string",
            "description":"The date and time when the ad hoc alert becomes active.",
            "format":"date-time",
            "nullable":true
        },
        "ToAddress":{
            "title":"Sent To",
            "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.",
            "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(required):
  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(required):
  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 : publicSectorAdhocAlerts-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

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

  Maximum Length: 1000

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

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

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

  Maximum Length: 1000

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Maximum Length: 1

  Default Value: false

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who updated the ad hoc alert most recently.
• links: array Links
  Title: Links

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

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

  Maximum Length: 100

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

  Maximum Length: 30

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

  Read Only: true

  The summary of the ad hoc alert message body.
• ToAddress: 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the ad hoc alert most recently.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the ad hoc alert.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the ad hoc alert was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The  user who created the ad hoc alert.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the ad hoc alert.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The comments entered by staff while creating the ad hoc alert.",
            "nullable":true,
            "x-queryable":true
        },
        "Subject":{
            "title":"Subject",
            "type":"string",
            "description":"The summary of the ad hoc alert message body.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordIdentifier":{
            "title":"Record Identifier",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the ad hoc alert.",
            "nullable":true,
            "x-queryable":true
        },
        "Alertbody":{
            "title":"Body",
            "maxLength":1000,
            "type":"string",
            "description":"The message body of the ad hoc alert.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AlertEnd":{
            "title":"Alert End Date",
            "type":"string",
            "description":"The date and time when the ad hoc alert is no longer active.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the ad hoc alert is available to be used. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LogId":{
            "title":"Log ID",
            "type":"integer",
            "description":"A logical identifier for the ad hoc alert. This ID is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AlertStart":{
            "title":"Alert Start Date",
            "type":"string",
            "description":"The date and time when the ad hoc alert becomes active.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ToAddress":{
            "title":"Sent To",
            "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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the ad hoc alert 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