Jump to

• Request
• Response

Get an event subscriber

get

/fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers/{EventSubscriberId}

Request

Path Parameters

• EventId(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=
• EventSubscriberId(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:
  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.

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 : eventSetups-eventSubscribers-item-response

Type: object

Show Source

• EventSubscriberId: integer (int64)
  Title: Event Subscriber ID

  Read Only: true

  The unique identifier for the subscriber to an event.
• eventSubscriberTimingRules: array Event Subscriber Timing Rules
  Title: Event Subscriber Timing Rules

  The event subscriber timing rules resource provides information on the timing rules for the event subscriber trigger, in relation to the event date. For example, a timing rule could be 2 days before event date.
• ExternalFlag: boolean
  Title: External Indicator

  Read Only: true

  Maximum Length: 1

  Indicates if the target is external, for example, an external SOAP service.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayloadTargetCode: string
  Title: Payload Target Code

  Read Only: true

  Maximum Length: 30

  The code for the payload target referenced in the target configuration data.
• PayloadTargetId: integer (int64)
  Title: Payload Target ID

  Read Only: true

  The resource which will provide the payload information required to process the event successfully.
• SeededDataFlag: boolean
  Title: Predefined Data Indicator

  Read Only: true

  Indicates whether the associated row is predefined.
• TargetCode: string
  Title: Target Code

  Maximum Length: 30

  The code for the target referenced in the target configuration data.
• TargetDescription: string
  Title: Target Description

  Read Only: true

  Maximum Length: 240

  The description of the event subscriber target.
• TargetId: integer (int64)
  Title: Target ID

  The identifier for the subscriber in the target configuration data.
• TargetName: string
  Title: Target Name

  Read Only: true

  Maximum Length: 50

  The name of the event subscriber target, such as Communication.

{
    "type":"object",
    "properties":{
        "TargetCode":{
            "title":"Target Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the target referenced in the target configuration data.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "TargetDescription":{
            "title":"Target Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the event subscriber target.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "eventSubscriberTimingRules":{
            "title":"Event Subscriber Timing Rules",
            "type":"array",
            "description":"The event subscriber timing rules resource provides information on the timing rules for the event subscriber trigger, in relation to the event date. For example, a timing rule could be 2 days before event date.",
            "items":{
                "$ref":"#/components/schemas/eventSetups-eventSubscribers-eventSubscriberTimingRules-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EventSubscriberId":{
            "title":"Event Subscriber ID",
            "type":"integer",
            "description":"The unique identifier for the subscriber to an event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TargetName":{
            "title":"Target Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the event subscriber target, such as Communication.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayloadTargetCode":{
            "title":"Payload Target Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code for the payload target referenced in the target configuration data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalFlag":{
            "title":"External Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the target is external, for example, an external SOAP service.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetId":{
            "title":"Target ID",
            "type":"integer",
            "description":"The identifier for the subscriber in the target configuration data.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "TargetName"
                ]
            },
            "x-queryable":true
        },
        "PayloadTargetId":{
            "title":"Payload Target ID",
            "type":"integer",
            "description":"The resource which will provide the payload information required to process the event successfully.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Event Subscriber Timing Rules

Type: array

Title: Event Subscriber Timing Rules

The event subscriber timing rules resource provides information on the timing rules for the event subscriber trigger, in relation to the event date. For example, a timing rule could be 2 days before event date.

Show Source

• Array of: object eventSetups-eventSubscribers-eventSubscriberTimingRules-item-response

{
    "title":"Event Subscriber Timing Rules",
    "type":"array",
    "description":"The event subscriber timing rules resource provides information on the timing rules for the event subscriber trigger, in relation to the event date. For example, a timing rule could be 2 days before event date.",
    "items":{
        "$ref":"#/components/schemas/eventSetups-eventSubscribers-eventSubscriberTimingRules-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 : eventSetups-eventSubscribers-eventSubscriberTimingRules-item-response

Type: object

Show Source

• EventSubscrTimingRuleId: integer (int64)
  Title: Event Subscriber Timing Rule ID

  Read Only: true

  The unique identifier for the timing rule associated with the subscriber of an event.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeededDataFlag: boolean
  Title: Predefined Data Indicator

  Read Only: true

  Indicates whether the associated row is predefined.
• TimingRuleCount: integer (int32)
  Title: Timing Rule Count

  The counter to keep track of how many times a particular rule has been triggered.
• TimingRuleTypeCode: string
  Title: Timing Rule Type Code

  Maximum Length: 30

  The code that indicates the timing rule type, for example, ORA_HEY_DAYS and ORA_HEY_MONTHS. A list of accepted values is defined in the lookup type ORA_HEY_PERIOD_TYPE.
• TimingRuleTypeCodeMeaning: string
  Title: Timing Rule Type Code Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the timing rule type code. For example, days for ORA_HEY_DAYS and months for ORA_HEY_MONTHS. A list of accepted values is defined in the lookup type ORA_HEY_PERIOD_TYPE.
• TransactionCode: string
  Title: Transaction Code

  Maximum Length: 30

  The communication setup code that's associated with the timing rule.

{
    "type":"object",
    "properties":{
        "TimingRuleTypeCodeMeaning":{
            "title":"Timing Rule Type Code Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The meaning of the timing rule type code. For example, days for ORA_HEY_DAYS and months for ORA_HEY_MONTHS. A list of accepted values is defined in the lookup type ORA_HEY_PERIOD_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeededDataFlag":{
            "title":"Predefined Data Indicator",
            "type":"boolean",
            "description":"Indicates whether the associated row is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "CreatedBy"
                ]
            }
        },
        "TransactionCode":{
            "title":"Transaction Code",
            "maxLength":"30",
            "type":"string",
            "description":"The communication setup code that's associated with the timing rule.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TimingRuleCount":{
            "title":"Timing Rule Count",
            "type":"integer",
            "description":"The counter to keep track of how many times a particular rule has been triggered.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"3"
            },
            "x-queryable":true
        },
        "EventSubscrTimingRuleId":{
            "title":"Event Subscriber Timing Rule ID",
            "type":"integer",
            "description":"The unique identifier for the timing rule associated with the subscriber of an event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TimingRuleTypeCode":{
            "title":"Timing Rule Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code that indicates the timing rule type, for example, ORA_HEY_DAYS and ORA_HEY_MONTHS. A list of accepted values is defined in the lookup type ORA_HEY_PERIOD_TYPE.",
            "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

TargetLOV

Operation: /fscmRestApi/resources/11.13.18.05/eventSubscriberTargets

The following properties are defined on the LOV link relation:

• Source Attribute: TargetCode; Target Attribute: TargetCode
• Display Attribute: TargetName

eventSubscriberTimingRules

Operation: /fscmRestApi/resources/11.13.18.05/eventSetups/{EventId}/child/eventSubscribers/{EventSubscriberId}/child/eventSubscriberTimingRules

Parameters:

• EventId: $request.path.EventId
• EventSubscriberId: $request.path.EventSubscriberId

The event subscriber timing rules resource provides information on the timing rules for the event subscriber trigger, in relation to the event date. For example, a timing rule could be 2 days before event date.

Back to Top