Jump to

• Request
• Response

Create a communication request

post

/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationRequests

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 ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the agency associated with the communication request.
• Email: boolean
  Default Value: false

  Indicates that the communication request uses the email channel type.
• EventCode: string
  The unique identifier for the communication event.
• Log: string (byte)
  The communication request error details.
• LogId: integer (int64)
  Title: Log ID

  The unique identifier of the communication request log. This ID is generated automatically by the application.
• LogMsgAttData: string
  The attachment details attached to the communication.
• Notification: boolean
  Default Value: false

  Indicates that the communication request uses the notification channel type.
• RecordFifthKeyName: string
  Title: Record Fifth Key Name

  Maximum Length: 32

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

  Maximum Length: 100

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

  Maximum Length: 32

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

  Maximum Length: 100

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

  Maximum Length: 32

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

  Maximum Length: 100

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

  Maximum Length: 100

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

  Maximum Length: 32

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

  Maximum Length: 100

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

  Maximum Length: 100

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

  Maximum Length: 32

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

  Maximum Length: 100

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

  Maximum Length: 30

  Default Value: ORA_I

  The status of the communication message.
• TemplateCode: string
  The unique identifier for the communication template associated with the communication request.
• Text: boolean
  Default Value: false

  Indicates that the communication request uses the text channel type.

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the communication message.",
            "nullable":false,
            "default":"ORA_I"
        },
        "Email":{
            "type":"boolean",
            "description":"Indicates that the communication request uses the email channel type.",
            "nullable":true,
            "default":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication request.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "RecordSubIdentifier":{
            "title":"Record Sub Identifier",
            "maxLength":100,
            "type":"string",
            "description":"The communication request sub identifier passed through the communication request.",
            "nullable":true
        },
        "Log":{
            "type":"string",
            "description":"The communication request error details.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LogMsgAttData":{
            "type":"string",
            "description":"The attachment details attached to the communication.",
            "nullable":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
        },
        "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
        },
        "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
        },
        "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
        },
        "Text":{
            "type":"boolean",
            "description":"Indicates that the communication request uses the text channel type.",
            "nullable":true,
            "default":false
        },
        "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
        },
        "EventCode":{
            "type":"string",
            "description":"The unique identifier for the communication event.",
            "nullable":true
        },
        "Notification":{
            "type":"boolean",
            "description":"Indicates that the communication request uses the notification channel type.",
            "nullable":true,
            "default":false
        },
        "RecordIdentifier":{
            "title":"Record Identifier",
            "maxLength":100,
            "type":"string",
            "description":"The communication request identifier passed through the communication request.",
            "nullable":true
        },
        "TemplateCode":{
            "type":"string",
            "description":"The unique identifier for the communication template associated with the communication request.",
            "nullable":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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "LogId":{
            "title":"Log ID",
            "type":"integer",
            "description":"The unique identifier of the communication request log. This ID is generated automatically 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(required):
  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(required):
  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 : publicSectorCommunicationRequests-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the agency associated with the communication request.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time that the communication message was created.
• Email: boolean
  Default Value: false

  Indicates that the communication request uses the email channel type.
• EventCode: string
  The unique identifier for the communication event.
• LastUpdateDate: string (date-time)
  Read Only: true

  The user who last updated the communication request.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

  The unique identifier of the communication request log. This ID is generated automatically by the application.
• LogMsgAttData: string
  The attachment details attached to the communication.
• Notification: boolean
  Default Value: false

  Indicates that the communication request uses the notification channel type.
• RecordFifthKeyName: string
  Title: Record Fifth Key Name

  Maximum Length: 32

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

  Maximum Length: 100

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

  Maximum Length: 32

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

  Maximum Length: 100

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

  Maximum Length: 32

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

  Maximum Length: 100

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

  Maximum Length: 100

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

  Maximum Length: 32

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

  Maximum Length: 100

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

  Maximum Length: 100

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

  Maximum Length: 32

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

  Maximum Length: 100

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

  Maximum Length: 30

  Default Value: ORA_I

  The status of the communication message.
• TemplateCode: string
  The unique identifier for the communication template associated with the communication request.
• Text: boolean
  Default Value: false

  Indicates that the communication request uses the text channel type.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time that the communication message was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Email":{
            "type":"boolean",
            "description":"Indicates that the communication request uses the email channel type.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication request.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "RecordFifthKeyValue":{
            "title":"Record Fifth Key Value",
            "maxLength":100,
            "type":"string",
            "description":"The fifth key value of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordSecondKeyValue":{
            "title":"Record Second Key Value",
            "maxLength":100,
            "type":"string",
            "description":"The second key value of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFourthKeyName":{
            "title":"Record Fourth Key Name",
            "maxLength":32,
            "type":"string",
            "description":"The fourth key name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "EventCode":{
            "type":"string",
            "description":"The unique identifier for the communication event.",
            "nullable":true,
            "x-queryable":true
        },
        "Notification":{
            "type":"boolean",
            "description":"Indicates that the communication request uses the notification channel type.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "RecordIdentifier":{
            "title":"Record Identifier",
            "maxLength":100,
            "type":"string",
            "description":"The communication request identifier passed through the communication request.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFirstKeyValue":{
            "title":"Record First Key Value",
            "maxLength":100,
            "type":"string",
            "description":"The first key value of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFourthKeyValue":{
            "title":"Record Fourth Key Value",
            "maxLength":100,
            "type":"string",
            "description":"The fourth key value of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordFifthKeyName":{
            "title":"Record Fifth Key Name",
            "maxLength":32,
            "type":"string",
            "description":"The fifth key name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date that the communication request 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":false,
            "default":"ORA_I",
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the communication request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordSubIdentifier":{
            "title":"Record Sub Identifier",
            "maxLength":100,
            "type":"string",
            "description":"The communication request sub identifier passed through the communication request.",
            "nullable":true,
            "x-queryable":true
        },
        "Log":{
            "type":"string",
            "description":"The communication request error details.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "LogMsgAttData":{
            "type":"string",
            "description":"The attachment details attached to the communication.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordThirdKeyValue":{
            "title":"Record Third Key Value",
            "maxLength":100,
            "type":"string",
            "description":"The third key value of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "Text":{
            "type":"boolean",
            "description":"Indicates that the communication request uses the text channel type.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "RecordThirdKeyName":{
            "title":"Record Third Key Name",
            "maxLength":32,
            "type":"string",
            "description":"The third key name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateCode":{
            "type":"string",
            "description":"The unique identifier for the communication template associated with the communication request.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordFirstKeyName":{
            "title":"Record First Key Name",
            "maxLength":32,
            "type":"string",
            "description":"The first key name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordSecondKeyName":{
            "title":"Record Second Key Name",
            "maxLength":32,
            "type":"string",
            "description":"The second key name of the communication resource associated with the event.",
            "nullable":true,
            "x-queryable":true
        },
        "LogId":{
            "title":"Log ID",
            "type":"integer",
            "description":"The unique identifier of the communication request log. This ID is generated automatically by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The user who last updated the communication request.",
            "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