Jump to

• Request
• Response

Create a communication event mapping

post

/fscmRestApi/resources/11.13.18.05/communicationSetups/{CommSetupId}/child/commEventMappings

Request

Path Parameters

• CommSetupId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• CommEventId: integer (int64)
  Title: Communication Event ID

  The unique identifier for communication event mapping.
• EventCode: string
  Title: Event Code

  Maximum Length: 30

  The unique code for the event, such as ADMINADDENRLL.
• EventId: integer (int64)
  Title: Event ID

  The unique identifier for an event.

{
    "type":"object",
    "properties":{
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for an event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CommEventId":{
            "title":"Communication Event ID",
            "type":"integer",
            "description":"The unique identifier for communication event mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the event, such as ADMINADDENRLL.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : communicationSetups-commEventMappings-item-response

Type: object

Show Source

• CommEventId: integer (int64)
  Title: Communication Event ID

  The unique identifier for communication event mapping.
• EventCode: string
  Title: Event Code

  Maximum Length: 30

  The unique code for the event, such as ADMINADDENRLL.
• EventDescription: string
  Title: Event Description

  Read Only: true

  Maximum Length: 240

  The description of an event that triggers a communication.
• EventId: integer (int64)
  Title: Event ID

  The unique identifier for an event.
• EventName: string
  Title: Event Name

  Read Only: true

  Maximum Length: 50

  The name of an event, such as Admissions Application Submission.
• EventTypeCode: string
  Title: Event Type Code

  Read Only: true

  Maximum Length: 30

  The code that indicates the type of the event, such as ORA_HEY_TRANSACTIONAL and ORA_HEY_DATE_BASED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "EventTypeCode":{
            "title":"Event Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the type of the event, such as ORA_HEY_TRANSACTIONAL and ORA_HEY_DATE_BASED. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for an event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CommEventId":{
            "title":"Communication Event ID",
            "type":"integer",
            "description":"The unique identifier for communication event mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of an event, such as Admissions Application Submission.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventDescription":{
            "title":"Event Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of an event that triggers a communication.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the event, such as ADMINADDENRLL.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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."
        }
    }
}

Links

EventSetupLOV

Operation: /fscmRestApi/resources/11.13.18.05/eventSetupsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: EventCode; Target Attribute: EventCode
• Display Attribute: EventName

Back to Top