Jump to

• Request
• Response

Get all communication details logs

get

/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRecordDetails

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a communication log that matches the specified primary key criteria.
    Finder Variables:
    • LogId; integer; The unique identifier for the communication request log.
    • LogMessageId; integer; The unique identifier for the communication log message.
  • simpleSearchFinder: Finds communication logs with the specified key word.
    Finder Variables:
    • value; string; The key word used to find a communication log such as status, channel type, or mime type.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AgencyId; integer; The unique identifier of the agency associated with the communication request log.
  • ApplicationAddress1; string; The Application Address Line 1 for Business Entity Location.
  • ApplicationAddress2; string; The Application Address Line 2 for Business Entity Location.
  • ApplicationAddress3; string; The Application Address Line 3 for Business Entity Location.
  • ApplicationAddress4; string; The Application Address Line 4 for Business Entity Location.
  • ApplicationCity; string; The Application City Name for Business Entity Location.
  • ApplicationCountry; string; The Application Country Name for Business Entity Location.
  • ApplicationCounty; string; The Application County Name for Business Entity Location.
  • ApplicationDbaBusinessName; string; Doing Business As name for Business Entity Location.
  • ApplicationOrganizationName; string; Organization Name for Business Entity Location.
  • ApplicationPostal; string; Postal code for Business Entity Location.
  • ApplicationState; string; State name for Business Entity Location.
  • AttachRowCount; string; The count of attachments for the communication.
  • BccEmailAddress; string; The blind copied recipient addresses for email communications.
  • CcEmailAddress; string; The copied recipient addresses for email communications.
  • ChannelType; string; The communication message channel type.
  • ChannelTypeMeaning; string; The communication channel type. The possible values are Email, Notification, and Alert.
  • CreatedBy; string; The user who created the communication message.
  • CreationDate; string; The date and time that the communication message was created.
  • EventId; integer; The unique identifier for the communication event.
  • FromAddress; string; The sender of the communication message.
  • LastUpdateDate; string; The user who last updated the communication message.
  • LastUpdatedBy; string; The date that the communication message was last updated.
  • LogId; integer; The unique identifier for the communication request log. This is automatically generated by the application.
  • LogMessageId; integer; The unique identifier for the communication log message. This is automatically generated by the application.
  • MessageDeleteAllowed; string; Indicates whether users are allowed to delete the message.
  • MessageLanguage; string; The language used for the communication message.
  • MessageSeq; integer; The communication message sequence number.
  • MimeType; string; The MIME type of communication message. The possible values are HTML and Text.
  • MimeTypeMeaning; string; The MIME type of communication message. The possible values are HTML and Text.
  • ObjectVersionNumber; integer; The message revision number.
  • PhoneNumber; string; The recipient phone number for text communications.
  • Priority; string; The priority of the notification.
  • Recipient; string; The recipients of the communication message.
  • RecordFifthKeyId; string; The fifth key id name of the communication resource associated with the event.
  • RecordFifthKeyName; string; The fifth key name of the communication resource associated with the event.
  • RecordFifthKeyValue; string; The fifth key value of the communication resource associated with the event.
  • RecordFirstKeyId; string; The first key id name of the communication resource associated with the event.
  • RecordFirstKeyName; string; The first key name of the communication resource associated with the event.
  • RecordFirstKeyValue; string; The first key value of the communication resource associated with the event.
  • RecordFourthKeyId; string; The fourth key id name of the communication resource associated with the event.
  • RecordFourthKeyName; string; The fourth key name of the communication resource associated with the event.
  • RecordFourthKeyValue; string; The fourth key value of the communication resource associated with the event.
  • RecordIdentifier; string; The communication request identifier passed through the communication request.
  • RecordSecondKeyId; string; The second key id name of the communication resource associated with the event.
  • RecordSecondKeyName; string; The second key name of the communication resource associated with the event.
  • RecordSecondKeyValue; string; The second key value of the communication resource associated with the event.
  • RecordSubIdentifier; string; The communication request sub identifier passed through the communication request.
  • RecordThirdKeyId; string; The third key id name of the communication resource associated with the event.
  • RecordThirdKeyName; string; The third key name of the communication resource associated with the event.
  • RecordThirdKeyValue; string; The third key value of the communication resource associated with the event.
  • ShortMessage; string; The short text message body.
  • SourceDescription; string; The event name for which the communication is triggered.
  • Status; string; The status of the communication message.
  • StatusMeaning; string; The status of the communication message.
  • Subject; string; The subject of the communication message.
  • TemplateId; integer; The unique identifier of the template associated with the communication.
  • ToEmailAddress; string; The primary recipient addresses for email communications.
  • UmsMsgId; string; The unique identifier generated by UMS for email messages.
  • UserId; string; The recipient user ID for notifications.
  • Visibility; string; The visibility option of the communication log.
  • VisibilityMeaning; string; The visibility option of the communication message.
  • WebformURL; string; Webform URL details for communication.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 : publicSectorCommunicationRecordDetails

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCommunicationRecordDetails-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Communications",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorCommunicationRecordDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCommunicationRecordDetails-item-response"
    }
}

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 : publicSectorCommunicationRecordDetails-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 communication request log.
• 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.
• AttachRowCount: string
  Read Only: true

  The count of attachments for the communication.
• BccEmailAddress: string
  Title: Bcc Email Address

  Read Only: true

  The blind copied recipient addresses for email communications.
• Body: string (byte)
  Title: Body

  Read Only: true

  The communication message body text.
• CcEmailAddress: string
  Title: Cc Email Address

  Read Only: true

  The copied recipient addresses for email communications.
• ChannelType: string
  Title: Channel Type

  Read Only: true

  Maximum Length: 30

  The communication message channel type.
• ChannelTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The communication channel type. The possible values are Email, Notification, and Alert.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the communication message.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time that the communication message was created.
• EventId: integer (int64)
  Title: Event ID

  The unique identifier for the communication event.
• FromAddress: string
  Title: From Address

  Read Only: true

  Maximum Length: 256

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

  Read Only: true

  The user who last updated the communication message.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

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

  Read Only: true

  The unique identifier for the communication request log. This is automatically generated by the application.
• LogMessageId: integer (int64)
  Title: Log Message ID

  Read Only: true

  The unique identifier for the communication log message. This is automatically generated by the application.
• MessageDeleteAllowed: string
  Read Only: true

  Maximum Length: 1

  Indicates whether users are allowed to delete the message.
• MessageLanguage: string
  Title: Message Language

  Read Only: true

  Maximum Length: 4

  The language used for the communication message.
• MessageSeq: integer (int64)
  Title: Message Sequence

  Read Only: true

  The communication 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.
• MimeTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The MIME type of communication message. The possible values are HTML and Text.
• ObjectVersionNumber: integer (int32)
  The message revision number.
• PhoneNumber: string
  Title: To Phone Number

  Read Only: true

  The recipient phone number for text communications.
• Priority: string
  Title: Priority

  Read Only: true

  Maximum Length: 1

  The priority of the notification.
• Recipient: string
  Title: Sent To

  Read Only: true

  The recipients of the communication 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

  Read Only: true

  Maximum Length: 32

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

  Read Only: true

  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

  Read Only: true

  Maximum Length: 32

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

  Read Only: true

  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

  Read Only: true

  Maximum Length: 32

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  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

  Read Only: true

  Maximum Length: 32

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

  Read Only: true

  Maximum Length: 100

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

  Read Only: true

  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

  Read Only: true

  Maximum Length: 32

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

  Read Only: true

  Maximum Length: 100

  The third key value of the communication resource associated with the event.
• ShortMessage: string
  Title: Short Message

  Read Only: true

  Maximum Length: 4000

  The short text message body.
• SourceDescription: string
  Title: Event Name

  Maximum Length: 500

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

  Read Only: true

  Maximum Length: 30

  The status of the communication message.
• StatusMeaning: string
  Read Only: true

  Maximum Length: 80

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

  Read Only: true

  Maximum Length: 1000

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

  Read Only: true

  The unique identifier of the template associated with the communication.
• ToEmailAddress: string
  Title: To Email Address

  Read Only: true

  The primary recipient addresses for email communications.
• UmsMsgId: string
  Title: UMS Message ID

  Read Only: true

  Maximum Length: 150

  The unique identifier generated by UMS for email messages.
• UserId: string
  Title: To User ID

  Read Only: true

  The recipient user ID for notifications.
• Visibility: string
  Title: Visibility

  Read Only: true

  Maximum Length: 30

  The visibility option of the communication log.
• VisibilityMeaning: string
  Read Only: true

  Maximum Length: 80

  The visibility option of the communication message.
• WebForms: array Web Forms
  Title: Web Forms

  The web forms resource is used to view web form details associated with the communications triggered through ad hoc emails and ad hoc notifications.
• WebformURL: string
  Read Only: true

  Maximum Length: 255

  Webform URL details for communication.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that the communication message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BccEmailAddress":{
            "title":"Bcc Email Address",
            "type":"string",
            "description":"The blind copied recipient addresses for email communications.",
            "nullable":true,
            "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
        },
        "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,
            "readOnly":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,
            "readOnly":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":{
            "maxLength":"255",
            "type":"string",
            "description":"Webform URL details for communication.",
            "nullable":true,
            "readOnly":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,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the communication message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The date that the communication message was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the communication message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "maxLength":"1",
            "type":"string",
            "description":"The priority of the notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachRowCount":{
            "type":"string",
            "description":"The count of attachments for the communication.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Recipient":{
            "title":"Sent To",
            "type":"string",
            "description":"The recipients of the communication message.",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "LogMessageId":{
            "title":"Log Message ID",
            "type":"integer",
            "description":"The unique identifier for the communication log message. This is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether users are allowed to delete the message.",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "Visibility":{
            "title":"Visibility",
            "maxLength":"30",
            "type":"string",
            "description":"The visibility option of the communication log.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LogId":{
            "title":"Log ID",
            "type":"integer",
            "description":"The unique identifier for the communication request log. This is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication request log.",
            "format":"int32",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "VisibilityMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The visibility option of the communication message.",
            "nullable":false,
            "readOnly":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
        },
        "RecordIdentifier":{
            "title":"Record Identifier",
            "maxLength":"100",
            "type":"string",
            "description":"The communication request identifier passed through the communication request.",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "FromAddress":{
            "title":"From Address",
            "maxLength":"256",
            "type":"string",
            "description":"The sender of the communication message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The message revision number.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "MessageLanguage":{
            "title":"Message Language",
            "maxLength":"4",
            "type":"string",
            "description":"The language used for the communication message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The communication channel type. The possible values are Email, Notification, and Alert.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Body":{
            "title":"Body",
            "type":"string",
            "description":"The communication message body text.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the template associated with the communication.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecordSubIdentifier":{
            "title":"Record Subidentifier",
            "maxLength":"100",
            "type":"string",
            "description":"The communication request sub identifier passed through the communication request.",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "MimeTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The MIME type of communication message. The possible values are HTML and Text.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Subject":{
            "title":"Subject",
            "maxLength":"1000",
            "type":"string",
            "description":"The subject of the communication message.",
            "nullable":true,
            "readOnly":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
        },
        "StatusMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The status of the communication message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageSeq":{
            "title":"Message Sequence",
            "type":"integer",
            "description":"The communication message sequence number.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShortMessage":{
            "title":"Short Message",
            "maxLength":"4000",
            "type":"string",
            "description":"The short text message body.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CcEmailAddress":{
            "title":"Cc Email Address",
            "type":"string",
            "description":"The copied recipient addresses for email communications.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserId":{
            "title":"To User ID",
            "type":"string",
            "description":"The recipient user ID for notifications.",
            "nullable":true,
            "readOnly":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,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"To Phone Number",
            "type":"string",
            "description":"The recipient phone number for text communications.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UmsMsgId":{
            "title":"UMS Message ID",
            "maxLength":"150",
            "type":"string",
            "description":"The unique identifier generated by UMS for email messages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelType":{
            "title":"Channel Type",
            "maxLength":"30",
            "type":"string",
            "description":"The communication message channel type.",
            "nullable":true,
            "readOnly":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
        },
        "WebForms":{
            "title":"Web Forms",
            "type":"array",
            "description":"The web forms resource is used to view web form details associated with the communications triggered through ad hoc emails and ad hoc notifications.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCommunicationRecordDetails-WebForms-item-response"
            }
        },
        "ToEmailAddress":{
            "title":"To Email Address",
            "type":"string",
            "description":"The primary recipient addresses for email communications.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PtoEmailId":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the communication message.",
            "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 : Web Forms

Type: array

Title: Web Forms

The web forms resource is used to view web form details associated with the communications triggered through ad hoc emails and ad hoc notifications.

Show Source

• Array of: object publicSectorCommunicationRecordDetails-WebForms-item-response

{
    "title":"Web Forms",
    "type":"array",
    "description":"The web forms resource is used to view web form details associated with the communications triggered through ad hoc emails and ad hoc notifications.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCommunicationRecordDetails-WebForms-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorCommunicationRecordDetails-WebForms-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The unique identifier for the agency associated with the web form.
• AnswerDate: string (date)
  The date and time answer of the web form message.
• AnswerNumber: number
  The numeric answer of the web form message.
• AnswerText: string
  Maximum Length: 1000

  The text answer of the web form message.
• AnswerType: string
  Title: Answer Type

  Maximum Length: 15

  The answer type of the web form message.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the web form message.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The creation date of the web form message.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date that the web form message was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the web form message.
• links: array Links
  Title: Links

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

  Read Only: true

  The unique identifier of the log associated with the web form message.
• LogMessageId: integer (int64)
  Title: Log Message ID

  The unique identifier for the communication message.
• Question: string
  Title: Question Text

  Maximum Length: 1000

  The question text of the web form message.
• WebformId: integer (int64)
  Title: Web Form ID

  Read Only: true

  The unique web form identifier for the communication message.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the web form message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The creation date of the web form message.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the web form message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the web form.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "WebformId":{
            "title":"Web Form ID",
            "type":"integer",
            "description":"The unique web form identifier for the communication message.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AnswerText":{
            "maxLength":"1000",
            "type":"string",
            "description":"The text answer of the web form message.",
            "nullable":true,
            "x-queryable":true
        },
        "LogMessageId":{
            "title":"Log Message ID",
            "type":"integer",
            "description":"The unique identifier for the communication message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AnswerNumber":{
            "type":"number",
            "description":"The numeric answer of the web form message.",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "scale":"3"
            },
            "x-queryable":true
        },
        "AnswerDate":{
            "type":"string",
            "description":"The date and time answer of the web form message.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Question":{
            "title":"Question Text",
            "maxLength":"1000",
            "type":"string",
            "description":"The question text of the web form message.",
            "nullable":false,
            "x-queryable":true
        },
        "AnswerType":{
            "title":"Answer Type",
            "maxLength":"15",
            "type":"string",
            "description":"The answer type of the web form message.",
            "nullable":false,
            "x-queryable":true
        },
        "LogId":{
            "title":"Log ID",
            "type":"integer",
            "description":"The unique identifier of the log associated with the web form message.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date that the web form message 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"
    }
}

Back to Top