"SUBSCRIPTION" OBJECT CODE
Introduced in API version 2.7.9
Object code format
[parent_object.]SUBSCRIPTION.property
Possible parent objects | Example |
---|---|
<none> | SUBSCRIPTION.PROGRAM.REF |
ADMISSION | ADMISSION.SUBSCRIPTION.PROGRAM.REF |
Returns information about a SUBSCRIPTION OBJECT
Context information
Required context objects |
---|
ADMISSION |
When this OBJECT CODE is used independently (no parent), the context information used to evaluate its value is determined by the ADMISSION where the OBJECT CODE is evaluated (i.e. the SUBSCRIPTION of the ADMISSION).
Otherwise the context information is inherited from the parent OBJECT
Properties
PROPERTY | DESCRIPTION |
---|---|
REF | Reference of the SUBSCRIPTION |
PROGRAM.* | To inquire about a PROGRAM property |
OWNER.* | "TEAM" OBJECT CODE to request information about the SUBSCRIPTION OWNER team |
SETTINGS.* | "SETTINGS" OBJECT CODE to request information about a setting of the SUBSCRIPTION. Introduced in API version 2.7.21 |
CONFIGURATION.* | "CONFIGURATION" OBJECT CODE To request information about a SUBSCRIPTION configuration parameter. Introduced in API version 2.7.22 |
TASK{task_code / task_id}[:SCOPE].* | "TASK" OBJECT CODE To request information about a TASK in the SUBSCRIPTION. Introduced in API version 2.7.18 |
FORM{form_code / form_id}[:SCOPE].* | "FORM" OBJECT CODE To request information about a FORM in the SUBSCRIPTION. Introduced in API version 2.7.18 |
ITEM{#}.* | "ITEM" OBJECT CODE To request information about an ITEM in the SUBSCRIPTION. Introduced in API version 2.7.18 |