Jump to

• Request
• Response

Get an ad hoc notification

get

/fscmRestApi/resources/11.13.18.05/publicSectorAdhocNotifications/{LogId}

Request

Path Parameters

• LogId(required): integer(int64)
  The unique identifier for the communication ad hoc notification. This ID is automatically generated by the application.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : publicSectorAdhocNotifications-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the agency associated with the ad hoc notification.
• ApplicationAddress1: string
  Title: Application Address 1

  Maximum Length: 240

  The Application Address Line 1 for Business Entity Location.
• ApplicationAddress2: string
  Title: Application Address 2

  Maximum Length: 240

  The Application Address Line 2 for Business Entity Location.
• ApplicationAddress3: string
  Title: Application Address 3

  Maximum Length: 240

  The Application Address Line 3 for Business Entity Location.
• ApplicationAddress4: string
  Title: Application Address 4

  Maximum Length: 240

  The Application Address Line 4 for Business Entity Location.
• ApplicationCity: string
  Title: Application City

  Maximum Length: 60

  The Application City Name for Business Entity Location.
• ApplicationCountry: string
  Title: Application Country

  Maximum Length: 3

  The Application Country Name for Business Entity Location.
• ApplicationCounty: string
  Title: Application County

  Maximum Length: 20

  The Application County Name for Business Entity Location.
• ApplicationDbaBusinessName: string
  Title: Doing Business As

  Maximum Length: 360

  Doing Business As name for Business Entity Location.
• ApplicationOrganizationName: string
  Title: Organization Name

  Maximum Length: 360

  Organization Name for Business Entity Location.
• ApplicationPostal: string
  Title: Application Postal Code

  Maximum Length: 60

  Postal code for Business Entity Location.
• ApplicationState: string
  Title: Application State

  Maximum Length: 60

  State name for Business Entity Location.
• Body: string
  The body of the ad hoc notification.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the ad hoc notification request.
• CreationDate: string (date-time)
  Read Only: true

  The date and time that the ad hoc notification request was created.
• EventId: integer (int64)
  Title: Event ID

  The unique identifier for the communication event.
• FromAddress: string
  The sender address of the ad hoc notification.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date that the ad hoc notification request was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the communication ad hoc notification request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Log: string (byte)
  The communication ad hoc notification request error details.
• LogId: integer (int64)
  Title: Log ID

  The unique identifier for the communication ad hoc notification. This ID is automatically generated by the application.
• LogMsgAttData: string
  The attachment details attached to the notification.
• MessageDeleteAllowed: boolean
  Indicates that a user can delete this message from their notification list.
• MimeType: string
  The MIME type of the ad hoc notification message. The possible values are HTML and Text.
• PayloadData: string
  The data payload provided with ad hoc notification request.
• PreferredLanguage: string
  The language used for the notification message.
• Priority: string
  The priority of the message.
• RecordFifthKeyId: string
  Title: Record Fifth Key ID

  Maximum Length: 100

  The fifth key id name of the communication resource associated with the event.
• RecordFifthKeyName: string
  Title: Record Fifth Key Name

  Maximum Length: 32

  The fifth key name of the communication resource associated with the event.
• RecordFifthKeyValue: string
  Title: Record Fifth Key Value

  Maximum Length: 100

  The fifth key value of the communication resource associated with the event.
• RecordFirstKeyId: string
  Title: Record First Key ID

  Maximum Length: 100

  The first key id name of the communication resource associated with the event.
• RecordFirstKeyName: string
  Title: Record First Key Name

  Maximum Length: 32

  The first key name of the communication resource associated with the event.
• RecordFirstKeyValue: string
  Title: Record First Key Value

  Maximum Length: 100

  The first key value of the communication resource associated with the event.
• RecordFourthKeyId: string
  Title: Record Fourth Key ID

  Maximum Length: 100

  The fourth key id name of the communication resource associated with the event.
• RecordFourthKeyName: string
  Title: Record Fourth Key Name

  Maximum Length: 32

  The fourth key name of the communication resource associated with the event.
• RecordFourthKeyValue: string
  Title: Record Fourth Key Value

  Maximum Length: 100

  The fourth key value of the communication resource associated with the event.
• RecordIdentifier: string
  Title: Record Identifier

  Maximum Length: 100

  The communication request identifier passed through the communication request.
• RecordSecondKeyId: string
  Title: Record Second Key ID

  Maximum Length: 100

  The second key id name of the communication resource associated with the event.
• RecordSecondKeyName: string
  Title: Record Second Key Name

  Maximum Length: 32

  The second key name of the communication resource associated with the event.
• RecordSecondKeyValue: string
  Title: Record Second Key Value

  Maximum Length: 100

  The second key value of the communication resource associated with the event.
• RecordSubIdentifier: string
  Title: Record Subidentifier

  Maximum Length: 100

  The communication request sub identifier passed through the communication request.
• RecordThirdKeyId: string
  Title: Record Third Key ID

  Maximum Length: 100

  The third key id name of the communication resource associated with the event.
• RecordThirdKeyName: string
  Title: Record Third Key Name

  Maximum Length: 32

  The third key name of the communication resource associated with the event.
• RecordThirdKeyValue: string
  Title: Record Third Key Value

  Maximum Length: 100

  The third key value of the communication resource associated with the event.
• ResourceEndPoint: string
  The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc notification.
• RunEnd: string (date-time)
  The date and time that the ad hoc notification was deleted.
• RunStart: string (date-time)
  The date and time that the ad hoc notification was created.
• SourceDescription: string
  Title: Event Name

  Maximum Length: 500

  The event name for which the communication is triggered.
• Status: string
  Title: Status

  Maximum Length: 30

  The status of the ad hoc notification request.
• Subject: string
  The subject of the ad hoc notification.
• ToAddress: string
  The user IDs of the ad hoc notification's primary recipients.
• Visibility: string
  Visibility option of the triggered ad hoc notification.
• WebFormData: string
  The web form details attached to the notification.
• WebformURL: string
  Title: Web Form URL

  Read Only: true

  Maximum Length: 255

  Webform URL details for communication.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the ad hoc notification request was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationOrganizationName":{
            "title":"Organization Name",
            "maxLength":"360",
            "type":"string",
            "description":"Organization Name for Business Entity Location.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationCity":{
            "title":"Application City",
            "maxLength":"60",
            "type":"string",
            "description":"The Application City Name for Business Entity Location.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordThirdKeyId":{
            "title":"Record Third Key ID",
            "maxLength":"100",
            "type":"string",
            "description":"The third key id name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordSecondKeyValue":{
            "title":"Record Second Key Value",
            "maxLength":"100",
            "type":"string",
            "description":"The second key value of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFourthKeyName":{
            "title":"Record Fourth Key Name",
            "maxLength":"32",
            "type":"string",
            "description":"The fourth key name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationAddress4":{
            "title":"Application Address 4",
            "maxLength":"240",
            "type":"string",
            "description":"The Application Address Line 4 for Business Entity Location.",
            "nullable":true,
            "x-queryable":true
        },
        "WebformURL":{
            "title":"Web Form URL",
            "maxLength":"255",
            "type":"string",
            "description":"Webform URL details for communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WebFormData":{
            "type":"string",
            "description":"The web form details attached to the notification.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFirstKeyValue":{
            "title":"Record First Key Value",
            "maxLength":"100",
            "type":"string",
            "description":"The first key value of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationAddress3":{
            "title":"Application Address 3",
            "maxLength":"240",
            "type":"string",
            "description":"The Application Address Line 3 for Business Entity Location.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationAddress2":{
            "title":"Application Address 2",
            "maxLength":"240",
            "type":"string",
            "description":"The Application Address Line 2 for Business Entity Location.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationAddress1":{
            "title":"Application Address 1",
            "maxLength":"240",
            "type":"string",
            "description":"The Application Address Line 1 for Business Entity Location.",
            "nullable":true,
            "x-queryable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for the communication event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordFifthKeyName":{
            "title":"Record Fifth Key Name",
            "maxLength":"32",
            "type":"string",
            "description":"The fifth key name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the communication ad hoc notification request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the ad hoc notification request.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the ad hoc notification request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Log":{
            "type":"string",
            "description":"The communication ad hoc notification request error details.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Priority":{
            "type":"string",
            "description":"The priority of the message.",
            "nullable":true,
            "x-queryable":true
        },
        "PayloadData":{
            "type":"string",
            "description":"The data payload provided with ad hoc notification request.",
            "nullable":true,
            "x-queryable":true
        },
        "LogMsgAttData":{
            "type":"string",
            "description":"The attachment details attached to the notification.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordThirdKeyName":{
            "title":"Record Third Key Name",
            "maxLength":"32",
            "type":"string",
            "description":"The third key name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationCounty":{
            "title":"Application County",
            "maxLength":"20",
            "type":"string",
            "description":"The Application County Name for Business Entity Location.",
            "nullable":true,
            "x-queryable":true
        },
        "MessageDeleteAllowed":{
            "type":"boolean",
            "description":"Indicates that a user can delete this message from their notification list.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFirstKeyId":{
            "title":"Record First Key ID",
            "maxLength":"100",
            "type":"string",
            "description":"The first key id name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordSecondKeyName":{
            "title":"Record Second Key Name",
            "maxLength":"32",
            "type":"string",
            "description":"The second key name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "Visibility":{
            "type":"string",
            "description":"Visibility option of the triggered ad hoc notification.",
            "nullable":true,
            "x-queryable":true
        },
        "LogId":{
            "title":"Log ID",
            "type":"integer",
            "description":"The unique identifier for the communication ad hoc notification. This ID is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ToAddress":{
            "type":"string",
            "description":"The user IDs of the ad hoc notification's primary recipients.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationPostal":{
            "title":"Application Postal Code",
            "maxLength":"60",
            "type":"string",
            "description":"Postal code for Business Entity Location.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the ad hoc notification.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "RecordSecondKeyId":{
            "title":"Record Second Key ID",
            "maxLength":"100",
            "type":"string",
            "description":"The second key id name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFifthKeyValue":{
            "title":"Record Fifth Key Value",
            "maxLength":"100",
            "type":"string",
            "description":"The fifth key value of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceEndPoint":{
            "type":"string",
            "description":"The communication resource REST endpoint for generating data payload to replace parameters from the ad hoc notification.",
            "nullable":true,
            "x-queryable":true
        },
        "MimeType":{
            "type":"string",
            "description":"The MIME type of the ad hoc notification message. The possible values are HTML and Text.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordIdentifier":{
            "title":"Record Identifier",
            "maxLength":"100",
            "type":"string",
            "description":"The communication request identifier passed through the communication request.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFourthKeyValue":{
            "title":"Record Fourth Key Value",
            "maxLength":"100",
            "type":"string",
            "description":"The fourth key value of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "FromAddress":{
            "type":"string",
            "description":"The sender address of the ad hoc notification.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredLanguage":{
            "type":"string",
            "description":"The language used for the notification message.",
            "nullable":true,
            "x-queryable":true
        },
        "Body":{
            "type":"string",
            "description":"The body of the ad hoc notification.",
            "nullable":true,
            "x-queryable":true
        },
        "RunEnd":{
            "type":"string",
            "description":"The date and time that the ad hoc notification was deleted.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RunStart":{
            "type":"string",
            "description":"The date and time that the ad hoc notification was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RecordSubIdentifier":{
            "title":"Record Subidentifier",
            "maxLength":"100",
            "type":"string",
            "description":"The communication request sub identifier passed through the communication request.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationState":{
            "title":"Application State",
            "maxLength":"60",
            "type":"string",
            "description":"State name for Business Entity Location.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationCountry":{
            "title":"Application Country",
            "maxLength":"3",
            "type":"string",
            "description":"The Application Country Name for Business Entity Location.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordThirdKeyValue":{
            "title":"Record Third Key Value",
            "maxLength":"100",
            "type":"string",
            "description":"The third key value of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "Subject":{
            "type":"string",
            "description":"The subject of the ad hoc notification.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFourthKeyId":{
            "title":"Record Fourth Key ID",
            "maxLength":"100",
            "type":"string",
            "description":"The fourth key id name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFirstKeyName":{
            "title":"Record First Key Name",
            "maxLength":"32",
            "type":"string",
            "description":"The first key name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFifthKeyId":{
            "title":"Record Fifth Key ID",
            "maxLength":"100",
            "type":"string",
            "description":"The fifth key id name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicationDbaBusinessName":{
            "title":"Doing Business As",
            "maxLength":"360",
            "type":"string",
            "description":"Doing Business As name for Business Entity Location.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date that the ad hoc notification request was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceDescription":{
            "title":"Event Name",
            "maxLength":"500",
            "type":"string",
            "description":"The event name for which the communication is triggered.",
            "nullable":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