Jump to

• Request
• Response

Get all communication details logs

get

/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRecordDetails

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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:
  
  

  • 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.
  • 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.
• 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.
• 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 attributes. 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
• 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".

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCommunicationRecordDetails

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  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(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "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.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorCommunicationRecordDetails-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorCommunicationRecordDetails-item

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

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorCommunicationRecordDetails-item

Type: object

Show Source

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

  The unique identifier of the agency associated with the communication request log.
• BccEmailAddress(optional): string
  Title: Bcc Email Address

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

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

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

  Maximum Length: 30

  The communication message channel type.
• ChannelTypeMeaning(optional): string
  Maximum Length: 80

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

  Maximum Length: 64

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

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

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

  Maximum Length: 256

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

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

  Maximum Length: 64

  The date that the communication message was last updated.
• links(optional): array Items
  Title: Items

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

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

  The unique identifier for the communication log message. This is automatically generated by the application.
• MessageDeleteAllowed(optional): string
  Maximum Length: 1

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

  Maximum Length: 4

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

  The communication message sequence number.
• MimeType(optional): string
  Title: MIME Type

  Maximum Length: 30

  The MIME type of communication message. The possible values are HTML and Text.
• MimeTypeMeaning(optional): string
  Maximum Length: 80

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

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

  Maximum Length: 1

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

  The recipients of the communication message.
• RecordFifthKeyName(optional): string
  Title: Record Fifth Key Name

  Maximum Length: 32

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

  Maximum Length: 100

  The fifth key value of the communication resource associated with the event.
• RecordFirstKeyName(optional): string
  Title: Record First Key Name

  Maximum Length: 32

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

  Maximum Length: 100

  The first key value of the communication resource associated with the event.
• RecordFourthKeyName(optional): string
  Title: Record Fourth Key Name

  Maximum Length: 32

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

  Maximum Length: 100

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

  Maximum Length: 100

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

  Maximum Length: 32

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

  Maximum Length: 100

  The second key value of the communication resource associated with the event.
• RecordSubIdentifier(optional): string
  Title: Record Sub Identifier

  Maximum Length: 100

  The communication request sub identifier passed through the communication request.
• RecordThirdKeyName(optional): string
  Title: Record Third Key Name

  Maximum Length: 32

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

  Maximum Length: 100

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

  Maximum Length: 4000

  The short text message body.
• Status(optional): string
  Title: Status

  Maximum Length: 30

  The status of the communication message.
• StatusMeaning(optional): string
  Maximum Length: 80

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

  Maximum Length: 1000

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

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

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

  Maximum Length: 150

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

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

  Maximum Length: 30

  The visibility option of the communication log.
• VisibilityMeaning(optional): string
  Maximum Length: 80

  The visibility option of the communication message.
• WebForms(optional): 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.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication request log.",
            "title":"Agency ID"
        },
        "BccEmailAddress":{
            "type":"string",
            "description":"The blind copied recipient addresses for email communications.",
            "title":"Bcc Email Address"
        },
        "Body":{
            "type":"string",
            "description":"The communication message body text.",
            "title":"Body"
        },
        "CcEmailAddress":{
            "type":"string",
            "description":"The copied recipient addresses for email communications.",
            "title":"Cc Email Address"
        },
        "ChannelType":{
            "maxLength":30,
            "type":"string",
            "description":"The communication message channel type.",
            "title":"Channel Type"
        },
        "ChannelTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The communication channel type. The possible values are Email, Notification, and Alert."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the communication message.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the communication message was created.",
            "title":"Creation Date"
        },
        "EventId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the communication event.",
            "title":"Event ID"
        },
        "FromAddress":{
            "maxLength":256,
            "type":"string",
            "description":"The sender of the communication message.",
            "title":"From Address"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who last updated the communication message.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date that the communication message was last updated.",
            "title":"Last Updated By"
        },
        "LogId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the communication request log. This is automatically generated by the application.",
            "title":"Log ID"
        },
        "LogMessageId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the communication log message. This is automatically generated by the application.",
            "title":"Log Message ID"
        },
        "MessageDeleteAllowed":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether users are allowed to delete the message."
        },
        "MessageLanguage":{
            "maxLength":4,
            "type":"string",
            "description":"The language used for the communication message.",
            "title":"Message Language"
        },
        "MessageSeq":{
            "format":"int64",
            "type":"integer",
            "description":"The communication message sequence number.",
            "title":"Message Sequence"
        },
        "MimeType":{
            "maxLength":30,
            "type":"string",
            "description":"The MIME type of communication message. The possible values are HTML and Text.",
            "title":"MIME Type"
        },
        "MimeTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The MIME type of communication message. The possible values are HTML and Text."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The message revision number."
        },
        "PhoneNumber":{
            "type":"string",
            "description":"The recipient phone number for text communications.",
            "title":"To Phone Number"
        },
        "Priority":{
            "maxLength":1,
            "type":"string",
            "description":"The priority of the notification.",
            "title":"Priority"
        },
        "Recipient":{
            "type":"string",
            "description":"The recipients of the communication message.",
            "title":"Sent To"
        },
        "RecordFifthKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The fifth key name of the communication resource associated with the event.",
            "title":"Record Fifth Key Name"
        },
        "RecordFifthKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key value of the communication resource associated with the event.",
            "title":"Record Fifth Key Value"
        },
        "RecordFirstKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The first key name of the communication resource associated with the event.",
            "title":"Record First Key Name"
        },
        "RecordFirstKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The first key value of the communication resource associated with the event.",
            "title":"Record First Key Value"
        },
        "RecordFourthKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The fourth key name of the communication resource associated with the event.",
            "title":"Record Fourth Key Name"
        },
        "RecordFourthKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key value of the communication resource associated with the event.",
            "title":"Record Fourth Key Value"
        },
        "RecordIdentifier":{
            "maxLength":100,
            "type":"string",
            "description":"The communication request identifier passed through the communication request.",
            "title":"Record Identifier"
        },
        "RecordSecondKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The second key name of the communication resource associated with the event.",
            "title":"Record Second Key Name"
        },
        "RecordSecondKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The second key value of the communication resource associated with the event.",
            "title":"Record Second Key Value"
        },
        "RecordSubIdentifier":{
            "maxLength":100,
            "type":"string",
            "description":"The communication request sub identifier passed through the communication request.",
            "title":"Record Sub Identifier"
        },
        "RecordThirdKeyName":{
            "maxLength":32,
            "type":"string",
            "description":"The third key name of the communication resource associated with the event.",
            "title":"Record Third Key Name"
        },
        "RecordThirdKeyValue":{
            "maxLength":100,
            "type":"string",
            "description":"The third key value of the communication resource associated with the event.",
            "title":"Record Third Key Value"
        },
        "ShortMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"The short text message body.",
            "title":"Short Message"
        },
        "Status":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the communication message.",
            "title":"Status"
        },
        "StatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The status of the communication message."
        },
        "Subject":{
            "maxLength":1000,
            "type":"string",
            "description":"The subject of the communication message.",
            "title":"Subject"
        },
        "TemplateId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the template associated with the communication.",
            "title":"Template ID"
        },
        "ToEmailAddress":{
            "type":"string",
            "description":"The primary recipient addresses for email communications.",
            "title":"To Email Address"
        },
        "UmsMsgId":{
            "maxLength":150,
            "type":"string",
            "description":"The unique identifier generated by UMS for email messages.",
            "title":"UMS Message ID"
        },
        "UserId":{
            "type":"string",
            "description":"The recipient user ID for notifications.",
            "title":"To User ID"
        },
        "Visibility":{
            "maxLength":30,
            "type":"string",
            "description":"The visibility option of the communication log.",
            "title":"Visibility"
        },
        "VisibilityMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The visibility option of the communication message."
        },
        "WebForms":{
            "items":{
                "$ref":"#/definitions/publicSectorCommunicationRecordDetails-WebForms-item"
            },
            "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.",
            "title":"Web Forms"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Nested Schema : 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

{
    "items":{
        "$ref":"#/definitions/publicSectorCommunicationRecordDetails-WebForms-item"
    },
    "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.",
    "title":"Web Forms"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : publicSectorCommunicationRecordDetails-WebForms-item

Type: object

Show Source

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

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

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

  Maximum Length: 15

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

  Maximum Length: 64

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

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

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

  Maximum Length: 64

  The user who last updated the web form message.
• links(optional): array Items
  Title: Items

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

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

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

  Maximum Length: 1000

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

  The unique identifier for the web form attached with the communication message. This ID is automatically generated by the application.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency associated with the web form.",
            "title":"Agency ID"
        },
        "AnswerDate":{
            "format":"date",
            "type":"string",
            "description":"The date and time answer of the web form message."
        },
        "AnswerNumber":{
            "type":"number",
            "description":"The numeric answer of the web form message."
        },
        "AnswerText":{
            "maxLength":1000,
            "type":"string",
            "description":"The text answer of the web form message."
        },
        "AnswerType":{
            "maxLength":15,
            "type":"string",
            "description":"The answer type of the web form message.",
            "title":"Answer Type"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the web form message.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The creation date of the web form message.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the web form message was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the web form message.",
            "title":"Last Updated By"
        },
        "LogId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the log associated with the web form message.",
            "title":"Log ID"
        },
        "LogMessageId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the communication message.",
            "title":"Log Message ID"
        },
        "Question":{
            "maxLength":1000,
            "type":"string",
            "description":"The question text of the web form message.",
            "title":"Question Text"
        },
        "WebformId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the web form attached with the communication message. This ID is automatically generated by the application.",
            "title":"Web Form ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

Back to Top