Jump to

• Request
• Response

Get a category event

get

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

Request

Path Parameters

• CategoryEventMapId(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=
• 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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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.

There's no request body for this operation.

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":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an event is active or inactive.",
            "nullable":false,
            "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
        },
        "EventCode":{
            "title":"Event Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for an event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventDescription":{
            "title":"Event Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of an event.",
            "nullable":false,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "SeededDataFlag":{
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":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-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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":{
        "TokenCode":{
            "title":"Token Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for a communication token.",
            "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
        },
        "TokenIsMandatoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the communication token is required for the mapped event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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