Jump to

• Request
• Response

Update an event subscriber target

patch

/fscmRestApi/resources/11.13.18.05/eventSubscriberTargets/{TargetId}

Request

Path Parameters

• TargetId(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: 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Indicator

  Maximum Length: 1

  Indicates whether the target is active or inactive.
• eventSetups: array Event Setups
  Title: Event Setups

  The event setups resource lists all the events associated with the target.
• ExternalFlag: boolean
  Title: External Indicator

  Maximum Length: 1

  Indicates whether the target is external or internal.
• InvocationHandle: string
  Title: Invocation Handle

  Maximum Length: 240

  The invocation handle of the target. For example, a Java target contains the fully qualified path of the Java method.
• TargetDescription: string
  Title: Target Description

  Maximum Length: 240

  The description of the target.
• TargetName: string
  Title: Target Name

  Maximum Length: 50

  The name of the target, such as Event Communication.
• TargetURLSuffix: string
  Title: Target URL Suffix

  Maximum Length: 240

  The suffix of the target URL. URL suffix means parameters at the end of URL.
• TargetValidationDate: string (date-time)
  Title: Target Validation Date

  Date on which the target URL was last validated.
• TargetValidationStatusCode: string
  Title: Target Validation Status Code

  Maximum Length: 30

  Validation status of the target URL.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the target is active or inactive.",
            "nullable":false
        },
        "ExternalFlag":{
            "title":"External Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the target is external or internal.",
            "nullable":false
        },
        "InvocationHandle":{
            "title":"Invocation Handle",
            "maxLength":240,
            "type":"string",
            "description":"The invocation handle of the target. For example, a Java target contains the fully qualified path of the Java method.",
            "nullable":true
        },
        "TargetDescription":{
            "title":"Target Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the target.",
            "nullable":true
        },
        "TargetName":{
            "title":"Target Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the target, such as Event Communication.",
            "nullable":false
        },
        "TargetURLSuffix":{
            "title":"Target URL Suffix",
            "maxLength":240,
            "type":"string",
            "description":"The suffix of the target URL. URL suffix means parameters at the end of URL.",
            "nullable":true
        },
        "TargetValidationDate":{
            "title":"Target Validation Date",
            "type":"string",
            "description":"Date on which the target URL was last validated.",
            "format":"date-time",
            "nullable":true
        },
        "TargetValidationStatusCode":{
            "title":"Target Validation Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Validation status of the target URL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "eventSetups":{
            "title":"Event Setups",
            "type":"array",
            "description":"The event setups resource lists all the events associated with the target.",
            "items":{
                "$ref":"#/components/schemas/eventSubscriberTargets-eventSetups-item-patch-request"
            }
        }
    }
}

Nested Schema : Event Setups

Type: array

Title: Event Setups

The event setups resource lists all the events associated with the target.

Show Source

• Array of: object eventSubscriberTargets-eventSetups-item-patch-request

{
    "title":"Event Setups",
    "type":"array",
    "description":"The event setups resource lists all the events associated with the target.",
    "items":{
        "$ref":"#/components/schemas/eventSubscriberTargets-eventSetups-item-patch-request"
    }
}

Nested Schema : eventSubscriberTargets-eventSetups-item-patch-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 : eventSubscriberTargets-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active Indicator

  Maximum Length: 1

  Indicates whether the target is active or inactive.
• eventSetups: array Event Setups
  Title: Event Setups

  The event setups resource lists all the events associated with the target.
• ExternalFlag: boolean
  Title: External Indicator

  Maximum Length: 1

  Indicates whether the target is external or internal.
• InvocationHandle: string
  Title: Invocation Handle

  Maximum Length: 240

  The invocation handle of the target. For example, a Java target contains the fully qualified path of the Java method.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the target configuration setup.
• 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.
• SystemDefinedFlag: boolean
  Title: Application Defined Indicator

  Maximum Length: 1

  Indicates if the event subscriber target is application defined.
• TargetCode: string
  Title: Target Code

  Maximum Length: 30

  The unique code for the target, such as EVENT_COMMUNICATION.
• TargetDescription: string
  Title: Target Description

  Maximum Length: 240

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

  Read Only: true

  The unique identifier for the target, for example, an identifier for communication.
• TargetName: string
  Title: Target Name

  Maximum Length: 50

  The name of the target, such as Event Communication.
• TargetTypeCode: string
  Title: Target Type Code

  Maximum Length: 30

  The code that indicates the target type, for example, ORA_HEY_REST_TARGET and or ORA_HEY_CALLBACK_TARGET. A list of accepted values is defined in the lookup type ORA_HEY_TARGET_TYPE.
• TargetTypeCodeMeaning: string
  Title: Target Type Code Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the target type code. For example, REST for ORA_HEY_REST_TARGET and Callback for ORA_HEY_CALLBACK_TARGET. A list of accepted values is defined in the lookup type ORA_HEY_TARGET_TYPE.
• TargetURLSuffix: string
  Title: Target URL Suffix

  Maximum Length: 240

  The suffix of the target URL. URL suffix means parameters at the end of URL.
• TargetValidationDate: string (date-time)
  Title: Target Validation Date

  Date on which the target URL was last validated.
• TargetValidationStatusCode: string
  Title: Target Validation Status Code

  Maximum Length: 30

  Validation status of the target URL.
• TargetValidationStatusMeaning: string
  Title: Target Validation Status Meaning

  Read Only: true

  Maximum Length: 80

  The meaning of the target validation status. A list of accepted values is defined in the lookup type ORA_HEY_TARGET_VALIDATION_STATUS.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the target is active or inactive.",
            "nullable":false,
            "x-queryable":true
        },
        "ExternalFlag":{
            "title":"External Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the target is external or internal.",
            "nullable":false,
            "x-queryable":true
        },
        "InvocationHandle":{
            "title":"Invocation Handle",
            "maxLength":240,
            "type":"string",
            "description":"The invocation handle of the target. For example, a Java target contains the fully qualified path of the Java method.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the target configuration 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 target configuration setup.",
            "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":true
        },
        "SystemDefinedFlag":{
            "title":"Application Defined Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the event subscriber target is application defined.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetCode":{
            "title":"Target Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code for the target, such as EVENT_COMMUNICATION.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetDescription":{
            "title":"Target Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the target.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetId":{
            "title":"Target ID",
            "type":"integer",
            "description":"The unique identifier for the target, for example, an identifier for communication.",
            "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 target, such as Event Communication.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetTypeCode":{
            "title":"Target Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the target type, for example, ORA_HEY_REST_TARGET and or ORA_HEY_CALLBACK_TARGET. A list of accepted values is defined in the lookup type ORA_HEY_TARGET_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TargetTypeCodeMeaning":{
            "title":"Target Type Code Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the target type code. For example, REST for ORA_HEY_REST_TARGET and Callback for ORA_HEY_CALLBACK_TARGET. A list of accepted values is defined in the lookup type ORA_HEY_TARGET_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetURLSuffix":{
            "title":"Target URL Suffix",
            "maxLength":240,
            "type":"string",
            "description":"The suffix of the target URL. URL suffix means parameters at the end of URL.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetValidationDate":{
            "title":"Target Validation Date",
            "type":"string",
            "description":"Date on which the target URL was last validated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TargetValidationStatusCode":{
            "title":"Target Validation Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Validation status of the target URL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TargetValidationStatusMeaning":{
            "title":"Target Validation Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the target validation status. A list of accepted values is defined in the lookup type ORA_HEY_TARGET_VALIDATION_STATUS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "eventSetups":{
            "title":"Event Setups",
            "type":"array",
            "description":"The event setups resource lists all the events associated with the target.",
            "items":{
                "$ref":"#/components/schemas/eventSubscriberTargets-eventSetups-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Event Setups

Type: array

Title: Event Setups

The event setups resource lists all the events associated with the target.

Show Source

• Array of: object eventSubscriberTargets-eventSetups-item-response

{
    "title":"Event Setups",
    "type":"array",
    "description":"The event setups resource lists all the events associated with the target.",
    "items":{
        "$ref":"#/components/schemas/eventSubscriberTargets-eventSetups-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 : eventSubscriberTargets-eventSetups-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Read Only: true

  Maximum Length: 1

  Indicates whether the event is active or inactive.
• EventCode: string
  Title: Event Code

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 240

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

  The unique identifier for the event, for example, an identifier for student enrollment event.
• EventName: string
  Title: Event Name

  Read Only: true

  Maximum Length: 50

  The name of the event, such as Add Enrollment.
• EventSubscriberId: integer (int64)
  Title: Event Subscriber ID

  Read Only: true

  The unique identifier for the event subscriber.
• EventTypeCode: string
  Title: Event Type

  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.
• ExternalFlag: boolean
  Title: External Source

  Read Only: true

  Maximum Length: 1

  Indicates if the event originated from an external source. For example, a grade posted event that originated from an external learning management system.
• 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.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the 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 the event, such as ADMINADDENRLL.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier for the event, for example, an identifier for student enrollment event.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "EventCode"
                ]
            },
            "x-queryable":true
        },
        "EventName":{
            "title":"Event Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the event, such as Add Enrollment.",
            "nullable":false,
            "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
        },
        "EventTypeCode":{
            "title":"Event Type",
            "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
        },
        "ExternalFlag":{
            "title":"External Source",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the event originated from an external source. For example, a grade posted event that originated from an external learning management system.",
            "nullable":true,
            "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":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

TargetTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_TARGET_TYPE%2CLookupCode%3D{TargetTypeCode}

The list of values for the target type code associated with the event subscriber targets.

TargetValidationStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_TARGET_VALIDATION_STATUS%2CLookupCode%3D{TargetValidationStatusCode}

The list of values for the target validation status code associated with the event subscriber targets.

eventSetups

Operation: /fscmRestApi/resources/11.13.18.05/eventSubscriberTargets/{TargetId}/child/eventSetups

Parameters:

• TargetId: $request.path.TargetId

The event setups resource lists all the events associated with the target.

Back to Top