Jump to

• Request
• Response

Get all communication error logs

get

/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationErrorLogs

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 error log that matches the specified primary key criteria.
    Finder Variables:
    • ErrorId; integer; The unique error identifier for identifying a communication error log row.
    • LogId; integer; The unique log identifier for identifying a communication error log row.
    • LogMessageId; integer; The unique log message identifier for identifying a communication error log row.
    • LogRecipientId; integer; The unique log recipient identifier for identifying a communication error log row.
  • simpleSearchFinder: Finds a communication error log with the specified keyword.
    Finder Variables:
    • numVal; integer; The number value that is used to find a communication error log, such as message ID.
    • value; string; The keyword used to find a communication error log.
• 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 error log.
  • ChannelType; string; The communication channel type. The possible values are Email, Notification, Alert, and Text.
  • Channeltypecode; string; The communication channel type code.
  • CreatedBy; string; The user who created the communication error log.
  • CreatedByName; string; The name of the user who created the communication error log.
  • CreationDate; string; The date and time when the communication error log was created.
  • DeletedFlag; string; Indicates whether the communciation event is still in use or deleted. The default value is N for no.
  • DeliveryType; string; The communication message delivery type. The possible values are To, Cc, and Bcc.
  • ErrorId; integer; The communciation error log identifier. This is automatically generated by the system.
  • ErrorSource; string; The communciation error log source information.
  • ErrorSourceId; integer; The communciation error log source identifier.
  • ErrorText; string; The communication error details.
  • EventCode; string; The status of the communciation log.
  • EventId; integer; The name for the communication event.
  • EventName; string; The unique identifier for the communication event.
  • FromAddress; string; The sender address of the communication message.
  • LastUpdateDate; string; The date when the communication error log was last updated.
  • LastUpdatedBy; string; The user who last updated the communication error log.
  • LogId; integer; The unique identifier of the communication request log associated with the communication error. This ID is generated automatically by the application.
  • LogMessageId; integer; The unique identifier for the communication log message associated with the communication error log. This is automatically generated by the application.
  • LogRecipientId; integer; The recipients of the communication message.
  • MessageStatus; string; The status of the communication message.
  • MimeType; string; The MIME type of the communication message. The possible values are HTML and Text.
  • RecipientStatus; string; The status field to indicate whether the recipient successfully received the communication message or not.
  • RecordFifthKeyName; string; The fifth key name of the transaction application..
  • RecordFifthKeyValue; string; The fifth key value of the transaction application.
  • RecordFirstKeyName; string; The first key name of the transaction application.
  • RecordFirstKeyValue; string; The first key value of the transaction application.
  • RecordFourthKeyName; string; The fourth key name of the transaction application.
  • RecordFourthKeyValue; string; The fourth key value of the transaction application.
  • RecordIdentifier; string; The communication request secondary identifier passed through the communication request.
  • RecordSecondKeyName; string; The second key name of the transaction application.
  • RecordSecondKeyValue; string; The second key value of the transaction application.
  • RecordThirdKeyName; string; The third key name of the transaction application.
  • RecordThirdKeyValue; string; The third key value of the transaction application.
  • ResourceId; integer; The identifier of the resource.
  • SentOn; string; The date when the communication message was sent.
  • SentTo; string; The recipient who received the communication message.
  • ShortMessage; string; The short text of the communication message.
  • Status; string; The fifth key name of the related communication resource.
  • Subject; string; The subject of the communication message.
  • TemplateCode; string; The unique identifier for the communication template associated with the communication message.
  • TemplateName; string; The name for the communication template associated with the communication message.
  • TotalErrorRecipients; integer; The total number of recipients who did not successfully receive the communication message.
  • TotalSuccessRecipients; integer; The total number of recipients who successfully received the communication message.
  • UmsMsgId; string; The unique identifier generated by UMS for email messages.
  • UpdatedByName; string; The name of the user who last udpated the communication error log.
  • Visibility; string; The visibility option of the communication message.
• 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 : publicSectorCommunicationErrorLogs

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/publicSectorCommunicationErrorLogs-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SharedServices",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorCommunicationErrorLogs-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCommunicationErrorLogs-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 : publicSectorCommunicationErrorLogs-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  The unique identifier of the agency associated with the communication error log.
• Body: string (byte)
  Read Only: true

  The communication message body text.
• ChannelType: string
  Read Only: true

  Maximum Length: 80

  The communication channel type. The possible values are Email, Notification, Alert, and Text.
• Channeltypecode: string
  Read Only: true

  Maximum Length: 30

  The communication channel type code.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the communication error log.
• CreatedByName: string
  Read Only: true

  The name of the user who created the communication error log.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the communication error log was created.
• DeletedFlag: string
  Read Only: true

  Maximum Length: 1

  Indicates whether the communciation event is still in use or deleted. The default value is N for no.
• DeliveryType: string
  Read Only: true

  Maximum Length: 80

  The communication message delivery type. The possible values are To, Cc, and Bcc.
• ErrorId: integer (int64)
  Title: Error ID

  Read Only: true

  The communciation error log identifier. This is automatically generated by the system.
• ErrorSource: string
  Title: Error Source

  Read Only: true

  Maximum Length: 30

  The communciation error log source information.
• ErrorSourceId: integer (int64)
  Title: Error Source ID

  Read Only: true

  The communciation error log source identifier.
• ErrorText: string
  Title: Error Text

  Read Only: true

  The communication error details.
• EventCode: string
  Read Only: true

  Maximum Length: 32

  The status of the communciation log.
• EventId: integer (int64)
  Read Only: true

  The name for the communication event.
• EventName: string
  Read Only: true

  Maximum Length: 500

  The unique identifier for the communication event.
• FromAddress: string
  Read Only: true

  Maximum Length: 256

  The sender address of the communication message.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the communication error log was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the communication error log.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LogId: integer (int64)
  Read Only: true

  The unique identifier of the communication request log associated with the communication error. This ID is generated automatically by the application.
• LogMessageId: integer (int64)
  Read Only: true

  The unique identifier for the communication log message associated with the communication error log. This is automatically generated by the application.
• LogRecipientId: integer (int64)
  Title: Log Recipient ID

  Read Only: true

  The recipients of the communication message.
• MessageStatus: string
  Read Only: true

  Maximum Length: 80

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

  Maximum Length: 80

  The MIME type of the communication message. The possible values are HTML and Text.
• RecipientStatus: string
  Read Only: true

  Maximum Length: 80

  The status field to indicate whether the recipient successfully received the communication message or not.
• RecordFifthKeyName: string
  Title: Record Fifth Key Name

  Read Only: true

  Maximum Length: 32

  The fifth key name of the transaction application..
• RecordFifthKeyValue: string
  Title: Record Fifth Key Value

  Read Only: true

  Maximum Length: 100

  The fifth key value of the transaction application.
• RecordFirstKeyName: string
  Title: Record First Key Name

  Read Only: true

  Maximum Length: 32

  The first key name of the transaction application.
• RecordFirstKeyValue: string
  Title: Record First Key Value

  Read Only: true

  Maximum Length: 100

  The first key value of the transaction application.
• RecordFourthKeyName: string
  Title: Record Fourth Key Name

  Read Only: true

  Maximum Length: 32

  The fourth key name of the transaction application.
• RecordFourthKeyValue: string
  Title: Record Fourth Key Value

  Read Only: true

  Maximum Length: 100

  The fourth key value of the transaction application.
• RecordIdentifier: string
  Title: Record Identifier

  Read Only: true

  Maximum Length: 100

  The communication request secondary identifier passed through the communication request.
• RecordSecondKeyName: string
  Title: Record Second Key Name

  Read Only: true

  Maximum Length: 32

  The second key name of the transaction application.
• RecordSecondKeyValue: string
  Title: Record Second Key Value

  Read Only: true

  Maximum Length: 100

  The second key value of the transaction application.
• RecordThirdKeyName: string
  Title: Record Third Key Name

  Read Only: true

  Maximum Length: 32

  The third key name of the transaction application.
• RecordThirdKeyValue: string
  Title: Record Third Key Value

  Read Only: true

  Maximum Length: 100

  The third key value of the transaction application.
• ResourceId: integer (int64)
  Read Only: true

  The identifier of the resource.
• SentOn: string (date-time)
  Read Only: true

  The date when the communication message was sent.
• SentTo: string
  Read Only: true

  Maximum Length: 256

  The recipient who received the communication message.
• ShortMessage: string
  Read Only: true

  Maximum Length: 4000

  The short text of the communication message.
• Status: string
  Read Only: true

  Maximum Length: 30

  The fifth key name of the related communication resource.
• Subject: string
  Read Only: true

  Maximum Length: 1000

  The subject of the communication message.
• TemplateCode: string
  Read Only: true

  Maximum Length: 32

  The unique identifier for the communication template associated with the communication message.
• TemplateName: string
  Read Only: true

  Maximum Length: 100

  The name for the communication template associated with the communication message.
• TotalErrorRecipients: integer (int64)
  Read Only: true

  The total number of recipients who did not successfully receive the communication message.
• TotalSuccessRecipients: integer (int64)
  Read Only: true

  The total number of recipients who successfully received the communication message.
• UmsMsgId: string
  Read Only: true

  Maximum Length: 150

  The unique identifier generated by UMS for email messages.
• UpdatedByName: string
  Read Only: true

  The name of the user who last udpated the communication error log.
• Visibility: string
  Read Only: true

  Maximum Length: 80

  The visibility option of the communication message.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the communication error log was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LogRecipientId":{
            "title":"Log Recipient ID",
            "type":"integer",
            "description":"The recipients of the communication message.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecordFourthKeyName":{
            "title":"Record Fourth Key Name",
            "maxLength":"32",
            "type":"string",
            "description":"The fourth key name of the transaction application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordSecondKeyValue":{
            "title":"Record Second Key Value",
            "maxLength":"100",
            "type":"string",
            "description":"The second key value of the transaction application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecipientStatus":{
            "maxLength":"80",
            "type":"string",
            "description":"The status field to indicate whether the recipient successfully received the communication message or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordFirstKeyValue":{
            "title":"Record First Key Value",
            "maxLength":"100",
            "type":"string",
            "description":"The first key value of the transaction application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorSourceId":{
            "title":"Error Source ID",
            "type":"integer",
            "description":"The communciation error log source identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"The name for the communication event.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "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 transaction application..",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeliveryType":{
            "maxLength":"80",
            "type":"string",
            "description":"The communication message delivery type. The possible values are To, Cc, and Bcc.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"30",
            "type":"string",
            "description":"The fifth key name of the related communication resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the communication error log.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the communication error log.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorText":{
            "title":"Error Text",
            "type":"string",
            "description":"The communication error details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordThirdKeyName":{
            "title":"Record Third Key Name",
            "maxLength":"32",
            "type":"string",
            "description":"The third key name of the transaction application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LogMessageId":{
            "type":"integer",
            "description":"The unique identifier for the communication log message associated with the communication error log. This is automatically generated by the application.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TemplateCode":{
            "maxLength":"32",
            "type":"string",
            "description":"The unique identifier for the communication template associated with the communication message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorId":{
            "title":"Error ID",
            "type":"integer",
            "description":"The communciation error log identifier. This is automatically generated by the system.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SentTo":{
            "maxLength":"256",
            "type":"string",
            "description":"The recipient who received the communication message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the communciation event is still in use or deleted. The default value is N for no.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordSecondKeyName":{
            "title":"Record Second Key Name",
            "maxLength":"32",
            "type":"string",
            "description":"The second key name of the transaction application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Visibility":{
            "maxLength":"80",
            "type":"string",
            "description":"The visibility option of the communication message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LogId":{
            "type":"integer",
            "description":"The unique identifier of the communication request log associated with the communication error. This ID is generated automatically by the application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TotalSuccessRecipients":{
            "type":"integer",
            "description":"The total number of recipients who successfully received the communication message.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"12"
            },
            "x-queryable":true
        },
        "CreatedByName":{
            "type":"string",
            "description":"The name of the user who created the communication error log.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication error log.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "RecordFifthKeyValue":{
            "title":"Record Fifth Key Value",
            "maxLength":"100",
            "type":"string",
            "description":"The fifth key value of the transaction application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventCode":{
            "maxLength":"32",
            "type":"string",
            "description":"The status of the communciation log.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MimeType":{
            "maxLength":"80",
            "type":"string",
            "description":"The MIME type of the 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 secondary identifier passed through the communication request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SentOn":{
            "type":"string",
            "description":"The date when the communication message was sent.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordFourthKeyValue":{
            "title":"Record Fourth Key Value",
            "maxLength":"100",
            "type":"string",
            "description":"The fourth key value of the transaction application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorSource":{
            "title":"Error Source",
            "maxLength":"30",
            "type":"string",
            "description":"The communciation error log source information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FromAddress":{
            "maxLength":"256",
            "type":"string",
            "description":"The sender address of the communication message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemplateName":{
            "maxLength":"100",
            "type":"string",
            "description":"The name for the communication template associated with the communication message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Body":{
            "type":"string",
            "description":"The communication message body text.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Channeltypecode":{
            "maxLength":"30",
            "type":"string",
            "description":"The communication channel type code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdatedByName":{
            "type":"string",
            "description":"The name of the user who last udpated the communication error log.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalErrorRecipients":{
            "type":"integer",
            "description":"The total number of recipients who did not successfully receive the communication message.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"12"
            },
            "x-queryable":true
        },
        "RecordThirdKeyValue":{
            "title":"Record Third Key Value",
            "maxLength":"100",
            "type":"string",
            "description":"The third key value of the transaction application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventName":{
            "maxLength":"500",
            "type":"string",
            "description":"The unique identifier for the communication event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Subject":{
            "maxLength":"1000",
            "type":"string",
            "description":"The subject of the communication message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageStatus":{
            "maxLength":"80",
            "type":"string",
            "description":"The status of the communication message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"The identifier of the resource.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShortMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"The short text of the communication message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordFirstKeyName":{
            "title":"Record First Key Name",
            "maxLength":"32",
            "type":"string",
            "description":"The first key name of the transaction application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UmsMsgId":{
            "maxLength":"150",
            "type":"string",
            "description":"The unique identifier generated by UMS for email messages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChannelType":{
            "maxLength":"80",
            "type":"string",
            "description":"The communication channel type. The possible values are Email, Notification, Alert, and Text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the communication error log 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