Jump to

• Request
• Response

Create a category event

post

/fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryEvents

Request

Path Parameters

• CategoryId(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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• EventId(required): integer (int64)
  Title: Event ID

  The unique identifier for an event that occurs in the application, for example, Enrollment Drop and Refund Posted.
• EventName(required): string
  Title: Event Name

  Maximum Length: 50

  The name of an event, such as Enrollment Drop.
• eventTokens: array Event Tokens
  Title: Event Tokens

  The event tokens resource provides a list of event tokens.

{
    "required":[
        "EventId",
        "EventName"
    ],
    "type":"object",
    "properties":{
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for an event that occurs in the application, for example, Enrollment Drop and Refund Posted.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "eventTokens":{
            "title":"Event Tokens",
            "type":"array",
            "description":"The event tokens resource provides a list of event tokens.",
            "items":{
                "$ref":"#/components/schemas/studentManagementCategories-categoryEvents-eventTokens-item-post-request"
            }
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of an event, such as Enrollment Drop.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Event Tokens

Type: array

Title: Event Tokens

The event tokens resource provides a list of event tokens.

Show Source

• Array of: object studentManagementCategories-categoryEvents-eventTokens-item-post-request

{
    "title":"Event Tokens",
    "type":"array",
    "description":"The event tokens resource provides a list of event tokens.",
    "items":{
        "$ref":"#/components/schemas/studentManagementCategories-categoryEvents-eventTokens-item-post-request"
    }
}

Nested Schema : studentManagementCategories-categoryEvents-eventTokens-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : studentManagementCategories-categoryEvents-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Read Only: true

  Maximum Length: 1

  Indicates whether an event is active or inactive.
• CategoryEventMapId: integer (int64)
  Title: Category Event Map ID

  Read Only: true

  The unique identifier for the category and event mapping.
• EventCode: string
  Title: Event Code

  Read Only: true

  Maximum Length: 30

  The unique code for an event.
• EventDescription: string
  Title: Event Description

  Read Only: true

  Maximum Length: 240

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

  The unique identifier for an event that occurs in the application, for example, Enrollment Drop and Refund Posted.
• EventName: string
  Title: Event Name

  Maximum Length: 50

  The name of an event, such as Enrollment Drop.
• EventTimingRuleCode: string
  Read Only: true

  Maximum Length: 30

  The timing rule type code for a date based event. For example, the ORA_HEY_EVENT_TIMING_AFTER code indicates a communication can be sent after the event occurs. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TIMING_RULE_TYPE.
• eventTokens: array Event Tokens
  Title: Event Tokens

  The event tokens resource provides a list of event tokens.
• EventTypeCode: string
  Title: Event Type

  Read Only: true

  Maximum Length: 30

  The type of an event, such as a transactional or date-based event. 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.
• SeededDataFlag: boolean
  Read Only: true

  Indicates whether the associated row is predefined.

{
    "type":"object",
    "properties":{
        "EventTypeCode":{
            "title":"Event Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of an event, such as a transactional or date-based event. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventTimingRuleCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The timing rule type code for a date based event. For example, the ORA_HEY_EVENT_TIMING_AFTER code indicates a communication can be sent after the event occurs. A list of accepted values is defined in the lookup type ORA_HEY_EVENT_TIMING_RULE_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryEventMapId":{
            "title":"Category Event Map ID",
            "type":"integer",
            "description":"The unique identifier for the category and event mapping.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SeededDataFlag":{
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for an event that occurs in the application, for example, Enrollment Drop and Refund Posted.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "eventTokens":{
            "title":"Event Tokens",
            "type":"array",
            "description":"The event tokens resource provides a list of event tokens.",
            "items":{
                "$ref":"#/components/schemas/studentManagementCategories-categoryEvents-eventTokens-item-response"
            }
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of an event, such as Enrollment Drop.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventDescription":{
            "title":"Event Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of an event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether an event is active or inactive.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for an event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Event Tokens

Type: array

Title: Event Tokens

The event tokens resource provides a list of event tokens.

Show Source

• Array of: object studentManagementCategories-categoryEvents-eventTokens-item-response

{
    "title":"Event Tokens",
    "type":"array",
    "description":"The event tokens resource provides a list of event tokens.",
    "items":{
        "$ref":"#/components/schemas/studentManagementCategories-categoryEvents-eventTokens-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 : studentManagementCategories-categoryEvents-eventTokens-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TokenCode: string
  Title: Token Code

  Read Only: true

  Maximum Length: 30

  The unique code for a communication token.
• TokenDescription: string
  Title: Token Description

  Read Only: true

  Maximum Length: 256

  The description of a communication token.
• TokenId: integer (int64)
  Title: Token ID

  Read Only: true

  The unique identifier for a communication token.
• TokenIsMandatoryFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates that the communication token is required for the mapped event.
• TokenName: string
  Title: Token Name

  Read Only: true

  Maximum Length: 30

  The name of a communication token, such as FIRST_NAME.
• TokenTypeCode: string
  Title: Token Type

  Read Only: true

  Maximum Length: 30

  The type of a communication token, such as a token specific to a single communication event or a token for all communications. A list of accepted values is defined in the lookup type ORA_HEY_TOKEN_TYPE.

{
    "type":"object",
    "properties":{
        "TokenIsMandatoryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the communication token is required for the mapped event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TokenName":{
            "title":"Token Name",
            "maxLength":"30",
            "type":"string",
            "description":"The name of a communication token, such as FIRST_NAME.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TokenDescription":{
            "title":"Token Description",
            "maxLength":"256",
            "type":"string",
            "description":"The description of a communication token.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TokenId":{
            "title":"Token ID",
            "type":"integer",
            "description":"The unique identifier for a communication token.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TokenCode":{
            "title":"Token Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for a communication token.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TokenTypeCode":{
            "title":"Token Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of a communication token, such as a token specific to a single communication event or a token for all communications. A list of accepted values is defined in the lookup type ORA_HEY_TOKEN_TYPE.",
            "nullable":true,
            "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."
        }
    }
}

Links

eventSetupsLOV

Operation: /fscmRestApi/resources/11.13.18.05/eventSetups

Parameters:

• finder: KeywordFinder

The list of values for the events.

eventTokens

Operation: /fscmRestApi/resources/11.13.18.05/studentManagementCategories/{CategoryId}/child/categoryEvents/{CategoryEventMapId}/child/eventTokens

Parameters:

• CategoryEventMapId: $request.path.CategoryEventMapId
• CategoryId: $request.path.CategoryId

The event tokens resource provides a list of event tokens.

Back to Top