Jump to

• Request
• Response

Create a communication resend request

post

/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResendMessages

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• LogMessageId: integer (int64)
  Title: Log Message ID

  The unique identifier of the communication message log. This ID is automatically generated by the application.
• MessageDeleteAllowed: string
  Maximum Length: 1

  Indicates that a user can delete this message from their notification list.
• ResendLogMessageId: integer
  Title: Log Message ID

  The unique identifier of the communication resend message. This ID is automatically generated by the application.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_RT

  The status of the communication message.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the communication message.",
            "nullable":true,
            "default":"ORA_RT"
        },
        "ResendLogMessageId":{
            "title":"Log Message ID",
            "type":"integer",
            "description":"The unique identifier of the communication resend message. This ID is automatically generated by the application.",
            "nullable":true
        },
        "MessageDeleteAllowed":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that a user can delete this message from their notification list.",
            "nullable":true
        },
        "LogMessageId":{
            "title":"Log Message ID",
            "type":"integer",
            "description":"The unique identifier of the communication message log. This ID is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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 : publicSectorCommunicationResendMessages-item-response

Type: object

Show Source

• 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.
• 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.
• LogMessageId: integer (int64)
  Title: Log Message ID

  The unique identifier of the communication message log. This ID is automatically generated by the application.
• MessageDeleteAllowed: string
  Maximum Length: 1

  Indicates that a user can delete this message from their notification list.
• ResendLogMessageId: integer
  Title: Log Message ID

  The unique identifier of the communication resend message. This ID is automatically generated by the application.
• Status: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_RT

  The status of the communication message.

{
    "type":"object",
    "properties":{
        "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
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the communication message.",
            "nullable":true,
            "default":"ORA_RT",
            "x-queryable":true
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the communication message.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageDeleteAllowed":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that a user can delete this message from their notification list.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResendLogMessageId":{
            "title":"Log Message ID",
            "type":"integer",
            "description":"The unique identifier of the communication resend message. This ID is automatically generated by the application.",
            "nullable":true,
            "x-queryable":true
        },
        "LogMessageId":{
            "title":"Log Message ID",
            "type":"integer",
            "description":"The unique identifier of the communication message log. This ID is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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
        }
    }
}

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