Jump to

• Request
• Response

Get an event subscriber

get

/fscmRestApi/resources/11.13.18.05/eventSubscribers/{EventSubscriberId}

Request

Path Parameters

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

Type: object

Show Source

• ContractConfiguration: string (byte)
  Title: Contract Configuration

  Read Only: true

  A JSON string containing the subscriber's data contract.
• EventSubscriberCode: string
  Title: Event Subscriber Code

  Read Only: true

  Maximum Length: 30

  The external identifier to store the Form Id of the form via which the application was created.
• EventSubscriberDescription: string
  Title: Event Subscriber Description

  Read Only: true

  Maximum Length: 255

  The description of the event subscriber.
• EventSubscriberId: integer (int64)
  Title: Event Subscriber ID

  Read Only: true

  The unique identifier for the event subscriber.
• EventSubscriberName: string
  Title: Event Subscriber Name

  Maximum Length: 50

  The name of the event subscriber.
• eventSubscriptions: array Event Subscriptions
  Title: Event Subscriptions

  The event subscriptions resource lists all the subscriptions of a subscriber. For example, a communication subscriber that's subscribed to a student enrollment event.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the event subscriber was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the event subscriber.
• links: array Links
  Title: Links

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

  Read Only: true

  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

  Read Only: true

  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":{
        "ContractConfiguration":{
            "title":"Contract Configuration",
            "type":"string",
            "description":"A JSON string containing the subscriber's data contract.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EventSubscriberCode":{
            "title":"Event Subscriber Code",
            "maxLength":30,
            "type":"string",
            "description":"The external identifier to store the Form Id of the form via which the application was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventSubscriberDescription":{
            "title":"Event Subscriber Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the event subscriber.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventSubscriberId":{
            "title":"Event Subscriber ID",
            "type":"integer",
            "description":"The unique identifier for the event subscriber.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EventSubscriberName":{
            "title":"Event Subscriber Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the event subscriber.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the event subscriber was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the event subscriber.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetCode":{
            "title":"Target Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the target referenced in the target configuration data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetDescription":{
            "title":"Target Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the event subscriber target.",
            "nullable":true,
            "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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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
        },
        "eventSubscriptions":{
            "title":"Event Subscriptions",
            "type":"array",
            "description":"The event subscriptions resource lists all the subscriptions of a subscriber. For example, a communication subscriber that's subscribed to a student enrollment event.",
            "items":{
                "$ref":"#/components/schemas/eventSubscribers-eventSubscriptions-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Event Subscriptions

Type: array

Title: Event Subscriptions

The event subscriptions resource lists all the subscriptions of a subscriber. For example, a communication subscriber that's subscribed to a student enrollment event.

Show Source

• Array of: object eventSubscribers-eventSubscriptions-item-response

{
    "title":"Event Subscriptions",
    "type":"array",
    "description":"The event subscriptions resource lists all the subscriptions of a subscriber. For example, a communication subscriber that's subscribed to a student enrollment event.",
    "items":{
        "$ref":"#/components/schemas/eventSubscribers-eventSubscriptions-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 : eventSubscribers-eventSubscriptions-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Read Only: true

  Maximum Length: 1

  Default Value: true

  Indicates whether the subscription is active or inactive.
• ContractConfiguration: string (byte)
  Title: Event Contract Configuration

  Read Only: true

  The contract configuration of the subscription. This includes all parameters mapped between the event and subscriber.
• EventId: integer (int64)
  Title: Event ID

  Read Only: true

  The unique identifier of the event.
• EventName: string
  Title: Event Name

  Read Only: true

  Maximum Length: 50

  The name of the event.
• EventSubscriptionCode: string
  Title: Event Subscription Code

  Read Only: true

  Maximum Length: 30

  The unique code for the subscription.
• EventSubscriptionId: integer (int64)
  Title: Event Subscription ID

  Read Only: true

  The unique identifier for the subscription.
• EventSubscriptionName: string
  Title: Event Subscription Name

  Read Only: true

  Maximum Length: 50

  The name of the subscription.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the event subscription was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the event subscription.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the subscription is active or inactive.",
            "nullable":false,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "ContractConfiguration":{
            "title":"Event Contract Configuration",
            "type":"string",
            "description":"The contract configuration of the subscription. This includes all parameters mapped between the event and subscriber.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier of the event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventSubscriptionCode":{
            "title":"Event Subscription Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the subscription.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventSubscriptionId":{
            "title":"Event Subscription ID",
            "type":"integer",
            "description":"The unique identifier for the subscription.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EventSubscriptionName":{
            "title":"Event Subscription Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the subscription.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the event subscription was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the event subscription.",
            "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"
            }
        }
    }
}

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

eventSubscriptions

Operation: /fscmRestApi/resources/11.13.18.05/eventSubscribers/{EventSubscriberId}/child/eventSubscriptions

Parameters:

• EventSubscriberId: $request.path.EventSubscriberId

The event subscriptions resource lists all the subscriptions of a subscriber. For example, a communication subscriber that's subscribed to a student enrollment event.

Back to Top