Jump to

• Request
• Response
• Examples

Get all activity templates

get

/crmRestApi/resources/11.13.18.05/activityTemplates

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the activity template with the specified primary key identifier.
    Finder Variables
    • TemplateId; integer; Finds the activity template with the template ID.
  • UniqueTemplateNameForSourceObject Finds the activity template name for the associated object .
    Finder Variables
    • SetId; integer; Finds the activity template based on the Set ID.
    • SourceObjectCode; string; Finds the activity template name for the associated object based on the source object code.
    • TemplateName; string; Finds the activity template based on the template name.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActiveFlag; boolean; Indicates whether the activity template is activated or not.
  • CreatedBy; string; The user who created the activity template.
  • CreationDate; string; The date when the activity template was created.
  • CustomRelationship; string; The relationship between the custom object and the activity template.
  • LastUpdateDate; string; The date when the activity template was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the activity template.
  • LastUpdatedBy; string; The user who last updated the activity template.
  • ObjectVersionNumber; integer; The attribute to capture number of updates on an activity template row.
  • OrchestrationId; integer; The unique identifier to identify the orchestration process.
  • SetId; integer; Finds the activity template based on the Set ID.
  • SourceObjectCd; string; The object type to which the template is associated with, such as Opportunity, Lead, and so on.
  • SourceObjectCode; string; The object type to which the template is associated with, such as Opportunity, Lead, and so on.
  • SubTypeCode; string; The subtype of the template such as Assessment.
  • TemplateDescription; string; A text field for capturing some descriptive information about the template.
  • TemplateId; integer; The unique identifier of the template.
  • TemplateName; string; The name of the activity template.
  • UserLastUpdateDate; string; The date when the record was last updated by a user in disconnect mode.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 : activityTemplates

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object activityTemplates-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-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 : activityTemplates-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Indicates whether the activity template is activated or not.
• Activity: array Activities
  Title: Activities

  Activity
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the activity template.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the activity template was created.
• CustomRelationship: string
  Maximum Length: 2000

  The relationship between the custom object and the activity template.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the activity template was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the activity template.
• LastUpdateLogin: string
  Title: Last Updated Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the activity template.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Title: Object Version Number

  Read Only: true

  The attribute to capture number of updates on an activity template row.
• OrchestrationId: integer (int64)
  The unique identifier to identify the orchestration process.
• SetId: integer (int64)
  Title: Template Set

  Finds the activity template based on the Set ID.
• SourceObjectCd: string
  Maximum Length: 30

  The object type to which the template is associated with, such as Opportunity, Lead, and so on.
• SourceObjectCode: string
  Title: Template Type

  Maximum Length: 30

  The object type to which the template is associated with, such as Opportunity, Lead, and so on.
• SubTypeCode: string
  Title: Subtype

  Maximum Length: 30

  The subtype of the template such as Assessment.
• TemplateDescription: string
  Title: Description

  Maximum Length: 250

  A text field for capturing some descriptive information about the template.
• TemplateFlag: string
  Read Only: true

  Maximum Length: 1

  Default Value: Y

  Indicates whether this is a template activity.
• TemplateId: integer (int64)
  Title: Template ID

  The unique identifier of the template.
• TemplateName: string
  Title: Template Name

  Maximum Length: 50

  The name of the activity template.
• UserLastUpdateDate: string (date-time)
  Title: User Last Update Date

  The date when the record was last updated by a user in disconnect mode.

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity template is activated or not.",
            "nullable":true,
            "x-hints":{
                "controlType":"default"
            },
            "x-queryable":true
        },
        "Activity":{
            "title":"Activities",
            "type":"array",
            "description":"Activity",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-Activity-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the activity template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the activity template was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomRelationship":{
            "maxLength":2000,
            "type":"string",
            "description":"The relationship between the custom object and the activity template.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the activity template was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the activity template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the activity template.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "title":"Object Version Number",
            "type":"integer",
            "description":"The attribute to capture number of updates on an activity template row.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "OrchestrationId":{
            "type":"integer",
            "description":"The unique identifier to identify the orchestration process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SetId":{
            "title":"Template Set",
            "type":"integer",
            "description":"Finds the activity template based on the Set ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "SourceObjectCd":{
            "maxLength":30,
            "type":"string",
            "description":"The object type to which the template is associated with, such as Opportunity, Lead, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Template Type",
            "maxLength":30,
            "type":"string",
            "description":"The object type to which the template is associated with, such as Opportunity, Lead, and so on.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubTypeCode":{
            "title":"Subtype",
            "maxLength":30,
            "type":"string",
            "description":"The subtype of the template such as Assessment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TemplateDescription":{
            "title":"Description",
            "maxLength":250,
            "type":"string",
            "description":"A text field for capturing some descriptive information about the template.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this is a template activity.",
            "nullable":true,
            "readOnly":true,
            "default":"Y",
            "x-queryable":false
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateName":{
            "title":"Template Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the activity template.",
            "nullable":true,
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated by a user in disconnect mode.",
            "format":"date-time",
            "nullable":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 : Activities

Type: array

Title: Activities

Activity

Show Source

• Array of: object activityTemplates-Activity-item-response

{
    "title":"Activities",
    "type":"array",
    "description":"Activity",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-Activity-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 : activityTemplates-Activity-item-response

Type: object

Show Source

• AccountAddress: string
  Title: Account Address

  Read Only: true

  The address of the account associated with the activity.
• AccountId: integer (int64)
  Title: Account ID

  The unique identifier of the account.
• AccountIdAttr: integer
  The attribute for the account identifier. This attribute isn't for public usage.
• AccountName: string
  Title: Account

  The name of the account associated to activity.
• AccountNameOsn: string
  Title: Social Account Name

  The account name displayed in Oracle Social Network.
• AccountNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 30

  The account number of the account associated with the activity.
• AccountPhoneNumber: string
  Title: Account Phone Number

  Read Only: true

  The phone number of the account associated with the activity.
• AccountStatus: string
  Read Only: true

  Maximum Length: 1

  The status of the account.
• AccountType: string
  Read Only: true

  Maximum Length: 30

  Indicates the type of the account.
• ActivityCreatedBy: string
  Title: Activity Created By

  Read Only: true

  Maximum Length: 64

  The activity user who created the activity.
• ActivityCreationDate: string (date-time)
  Title: Activity Creation Date

  Read Only: true

  The date when the activity was created.
• ActivityDescription: string (byte)
  Title: Description

  A text field for capturing some descriptive information about the activity.
• ActivityDirection: string
  Read Only: true

  The code indicating the direction of an activity.
• ActivityEndDate: string (date-time)
  Title: End Date

  The end date and time of an appointment, or the completion time of a task.
• ActivityFilter: string
  Read Only: true

  An attribute to add additional activity filter.
• ActivityFunctionCode: string
  Title: Activity

  Maximum Length: 30

  The task vs appointment. This is for system use only.
• ActivityFunctionCodeTrans: string
  Title: Activity

  Maximum Length: 255

  The activity function code.
• ActivityId: integer (int64)
  Title: Activity ID

  System generated nonnullable primary key of the table.
• ActivityLastUpdateLogin: string
  Title: Activity Last Update Login

  Read Only: true

  Maximum Length: 32

  Original Activity Last Update Login
• ActivityMtgMinutes: string (byte)
  Title: Meeting Minutes

  The activity meeting minutes.
• ActivityNumber: string
  Title: Activity Number

  Maximum Length: 64

  The alternate identifier of the activity.
• ActivityOutcome: string
  Read Only: true

  The outcome of the activity.
• ActivityPartialDescription: string
  Title: Short Description

  Maximum Length: 4000

  A column that stores the first 4000 characters of activity description.
• ActivityPriority: string
  Title: Priority

  Indicates the priority of the activity. This attribute isn't for public usage.
• ActivityStartDate: string (date-time)
  Title: Start Date

  The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation date time for a task.
• ActivityStatus: string
  Title: Status

  Read Only: true

  Indicates the status of the activity.
• ActivitySubtypeCode: string
  Title: Subtype

  Maximum Length: 30

  Displays a list of subtype values that are dependent on the value of the activity.
• ActivityTimezone: string
  Represents the time zone that the activity needs to be created in, other than the default logged in user's timezone preference.
• ActivityType: string
  Title: Activity Type

  The type of the activity.
• ActivityTypeCode: string
  Title: Type

  Maximum Length: 30

  The type or category of the activity.
• ActivityUpdateDate: string (date-time)
  Title: Activity Updated Date

  Read Only: true

  The date when the activity was updated.
• ActivityUpdatedBy: string
  Title: Activity Updated By

  Read Only: true

  Maximum Length: 64

  The user who updated the activity.
• ActivityUserLastUpdateDate: string (date-time)
  Title: Activity User Last Updated Date

  Read Only: true

  The date when the activity was last updated.
• AllDayFlag: boolean
  Title: All Day

  Maximum Length: 1

  Default Value: false

  Designates that an appointment is the entire day.
• AppointmentStatus: string
  Title: Appointment Status

  Maximum Length: 30

  The status of the appointment.
• ApptEndTime: string (date-time)
  Title: End Time

  Indicates the appointment end time.
• ApptStartTime: string (date-time)
  Title: Start Time

  Indicates the appointment start time.
• ArticleVersionId: string
  Title: Article Version ID

  Maximum Length: 64

  The unique identifier of the article version.
• AssessmentId: integer (int64)
  Title: Assessment ID

  The unique identifier of the assessment.
• AssetId: integer (int64)
  Title: Asset ID

  The unique identifier of the asset.
• AssetName: string
  Title: Asset

  The name of the asset.
• AssetNumber: string
  Title: Asset Number

  The alternate identifier of the asset.
• AssetSerialNumber: string
  Title: Asset Serial Number

  Read Only: true

  Maximum Length: 100

  The serial number of the asset.
• AttachmentEntityName: string
  Maximum Length: 255

  Default Value: ZMM_ACTY_ACTIVITIES

  The name of the attachment entity.
• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• AutoLogSource: string
  Title: Source System

  Maximum Length: 30

  For activities auto-generated through other systems, store the source system where it came from. We will use this information later in sync back logic to avoid double appearances of the same activity.
• BpId: integer (int64)
  Title: Business Plan ID

  The unique identifier of the business plan.
• BuOrgId: integer (int64)
  Title: Business Unit

  The unique identifier for the Business Unit. This attribute is obsolete.
• BusinessPlanName: string
  Title: Business Plan

  The business plan name associated to the activity.
• BusinessPlanNumber: string
  Title: Business Plan Number

  The business plan number of the business plan associated with the activity.
• CalendarAccess: boolean
  The access rights to calendar. This isn't for public usage.
• CalendarRecurType: string
  The activity recurrence type.
• CalendarSubject: string
  The activity subject.
• CalendarSubjectDay: string
  The title of the calendar.
• CalendarTimeType: string
  Indicates all day appointment. This isn't for public usage.
• CallReportCount: integer (int32)
  Title: Call Report Count

  Default Value: 0

  Indicates the number of call reports.
• CallReportUpcomingYN: string
  Indicates Y,N,M for upcoming appointments.
• CallReportYN: string
  Flag to Check if this activity has a Call Report
• CampaignId: integer (int64)
  Title: Campaign ID

  The unique identifier of the campaign.
• CampaignName: string
  Title: Campaign

  The name of the campaign associated to the activity.
• CampaignNumber: string
  Title: Campaign Number

  The campaign number of the campaign associated with the activity.
• CaseId: integer (int64)
  Title: Case ID

  The unique identifier of the case.
• CaseNumber: string
  Title: Case Number

  The alternate identifier of the case.
• CaseTitle: string
  Title: Title

  Read Only: true

  Maximum Length: 400

  The title of the case.
• CheckedInBy: string
  Title: Checked-In By

  Maximum Length: 64

  The name of the person who checks-in to a location.
• CheckedOutBy: string
  Title: Checked-Out By

  Maximum Length: 64

  The name of the person who checks-out to a location.
• CheckinDate: string (date-time)
  Title: Check-In Time

  Stores the date and time when a user checks in to an appointment.
• CheckinLatitude: number
  Title: Check-In Latitude

  Stores the latitude of a location where a user checks in to an appointment.
• CheckinLongitude: number
  Title: Check-In Longitude

  Stores the longitude of a location where a user checks in to an appointment.
• CheckoutDate: string (date-time)
  Title: Check-Out Time

  Stores the date and time when a user checks out of an appointment.
• CheckoutLatitude: number
  Title: Check-Out Latitude

  Stores the latitude of a location where a user checks out of an appointment.
• CheckoutLongitude: number
  Title: Check-Out Longitude

  Stores the longitude of a location where a user checks out of an appointment.
• ClaimId: integer (int64)
  Title: Claim ID

  The unique identifier of the claim.
• ClaimName: string
  Title: MDF Claim

  The name associated to the activity.
• ClaimNumber: string
  Title: Claim Number

  The number of the claim associated with the activity.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier of the conflict. This attribute isn't for public usage.
• ContactIDAttr: integer
  The contact identifier.
• ContactNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

  The contact number of primary contact associated with the activity.
• CorpCurrencyCode: string
  Title: Corporate Currency

  Maximum Length: 15

  The corporate currency code from profile.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the activity.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Attribute to capture the Date and Time the activity was created. This is defaulted by the application.
• CurcyConvRateType: string
  Title: Currency Conversion Rate

  Maximum Length: 30

  Holds the currency code of a record.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  Holds the currency conversion rate type from profile.
• CurrentDateForCallReport: string (date-time)
  Indicates the current date for the call report.
• CurrentDateForCallReportAttr: string (date-time)
  The attribute for the current date for the call report. This isn't for public usage.
• CurrentSystemDtTransient: string (date)
  Read Only: true

  The current system date.
• CustomerAccountId: integer (int64)
  Title: Customer Account ID

  The unique identifier of the customer account.
• DealId: integer (int64)
  Title: Deal ID

  The unique identifier of the related deal.
• DealNumber: string
  Title: Deal Registration

  The deal number associated to the activity.
• DelegatorId: integer (int64)
  Title: Delegator ID

  The activity resource that delegated activity ownership to another resource.
• DelegatorName: string
  Title: Delegated By

  The name of activity resource that delegated activity ownership to another resource.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the user has access to delete the record.
• DerivedAccountId: integer
  The unique identifier of the derived account.
• DirectionCode: string
  Title: Direction

  Maximum Length: 30

  The inbound or outbound. It's optional. The default is null.
• DismissAssignee: string
  Title: Dismissed

  Indicates whether the assignees is dismissed. Valid values are Y and N.
• DismissFlag: boolean
  Title: Dismissed

  Maximum Length: 1

  Indicates whether this activity is dismissed.
• DoNotCallFlag: boolean
  Read Only: true

  Flag to indicate if primary Contact can be called.
• DueDate: string (date)
  Title: Due Date

  The date the task activity is due to be completed.
• Duration: number
  Title: Duration

  The duration of an appointment or task.
• DynamicClaimLOVSwitcher: string
  Read Only: true

  The dynamic claim switcher.
• EmailSentDate: string (date-time)
  This field is used to capture the Activity Email Notification shared date for Outlook integration.
• EndDateForCallReport: string (date-time)
  The end date of the call report.
• EndDateForCallReportAttr: string (date-time)
  The attribute for end date of the call report. This isn't for public use.
• EndDtRFAttr: string (date-time)
  The attribute for activity start date. This isn't for public use.
• ExternalContactEmail: string
  Title: Primary Email

  Maximum Length: 320

  The email address of an external contact.
• ExternalContactName: string
  Title: External Contact Name

  Maximum Length: 360

  The name of an external contact.
• ExternallyOwnedFlag: boolean
  Title: Externally Owned

  Maximum Length: 1

  Default Value: false

  Indicates that the activity isn't created by an internal resource.
• FundRequestId: integer (int64)
  Title: Fund Request ID

  The unique identifier of the fund request.
• FundRequestName: string
  Title: MDF Request

  The fund request name associated to the activity.
• FundRequestNumber: string
  Title: Fund Request Number

  The fund request number of the fund request associated with the activity.
• IbAssetId: integer (int64)
  Title: IB Asset ID

  The unique identifier of the installed base asset associated with the activity.
• IbAssetNumber: string
  Title: Installed Base Asset

  The number of the installed base asset associated with the activity.
• IbAssetSerialNumber: string
  Title: Installed Base Asset Serial Number

  Read Only: true

  Maximum Length: 80

  The serial number of the installed base asset associated with the activity.
• InstNumDerivedFrom: string
  Default Value: Y

  The attribute to identify recurrence mode. This isn't for public use.
• IsClientService: string
  Default Value: Y

  The obsolete attribute. This isn't for public use.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The attribute to capture the date and time the activity was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The attribute to capture the identifier of the user who last updated the activity.
• LastUpdateLogin: string
  Title: Last Updated Login

  Read Only: true

  Maximum Length: 32

  The attribute to capture the identifiers of the user who last updated the activity.
• LeadId: integer (int64)
  Title: Lead ID

  Indicates the related lead to the activity.
• LeadIdAttr: integer
  The attribute for the lead identifier. This isn't for public use.
• LeadName: string
  Title: Lead

  Indicates the lead name.
• LeadNameOsn: string
  Title: Social Lead Name

  The lead name displayed in Oracle Social Network.
• LeadNumber: string
  Title: Lead Number

  The lead number of lead associated with the activity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Location: string
  Title: Location

  Maximum Length: 200

  Indicates the location of an appointment.
• LocationId: integer (int64)
  Title: Location ID

  The location or address ID of the activity account or primary contact.
• LoginUserRFAttr: integer
  The attribute for activity login user. This isn't for public use.
• MdfRequestId: integer
  The identifier for fund request.
• MobileActivityCode: string
  Title: Mobile Activity Code

  Maximum Length: 50

  The unique identifier of external mobile device.
• NotesLinkSourceCodeTransient: string
  Read Only: true

  The note source object.
• ObjectiveId: integer (int64)
  Title: Objective ID

  The unique identifier of the objective.
• OpportunityId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the related opportunity.
• OpportunityIdAttr: integer
  The attribute for the opportunity identifier. This isn't for public use.
• OpportunityName: string
  Title: Opportunity

  The name of opportunity associated to the activity.
• OpportunityNameOsn: string
  Title: Social Opportunity Name

  The opportunity name displayed in Oracle Social Network.
• OpportunityNumber: string
  Title: Opportunity Number

  The opportunity number of the opportunity associated with the activity.
• OrchestrationId: integer (int64)
  Title: Orchestration ID

  The unique identifier to identify the orchestration process.
• OrchestrationStepId: integer (int64)
  Title: Orchestration Step ID

  The unique identifier to identify the orchestration step.
• OrigEntityCode: string
  Maximum Length: 30

  Default Value: ACTIVITY

  The column to store the source of activity record during upgrade.
• OrigEntityNumber: string
  Maximum Length: 64

  The column to store the original user key of the object being upgraded to activity.
• OsnActivityId: integer (int64)
  The unique identifier for an activity.
• OtherPartyPhoneNumber: string
  Title: Other Party Phone Number

  Maximum Length: 40

  For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called.
• OutcomeCode: string
  Title: Outcome

  Maximum Length: 30

  The code of the outcome of the activity.
• OutlookAutoSyncFlag: boolean
  Title: Microsoft Auto-Synchronization

  Maximum Length: 1

  Indicates whether an appointment was automatically generated by the synchronization process from Microsoft 365.
• OutlookFlag: boolean
  Title: Outlook

  Maximum Length: 1

  Default Value: false

  Indicates whether the activity was created from Outlook and synced.
• OutlookGlobalId: string
  Title: Outlook Global ID

  Maximum Length: 1024

  The unique identifier of an appointment created from Microsoft 365.
• OutlookIdentifier: string
  Title: Outlook Identifier

  Maximum Length: 1024

  The unique identifier from outlook activity.
• OwnerAddress: string
  Title: Activity Owner Address

  Read Only: true

  The activity owner's address.
• OwnerEmailAddress: string
  Title: Activity Owner Email

  Read Only: true

  Maximum Length: 320

  The activity owner's email address.
• OwnerId: integer (int64)
  Title: Owner ID

  The primary resource on the activity. Supports resources only.
• OwnerName: string
  Title: Owner

  Maximum Length: 360

  The name of primary resource of activity.
• OwnerNameOsn: string
  Title: Social Owner Name

  The owner name displayed in Oracle Social Network.
• OwnerPhoneNumber: string
  Title: Activity Owner Phone Number

  Read Only: true

  The activity owner's phone number.
• ParentActivityId: integer (int64)
  Title: Parent ID

  The related activity identifier, only applicable if the record is a follow up activity.
• ParentActivityIdAttr: string
  The attribute for the parent activity identifier. This isn't for public use.
• PartialMtgMinutes: string
  Title: Short Meeting Minutes

  Maximum Length: 4000

  A column that stores a truncated string of the meeting minutes.
• PartnerEnrollmentId: integer (int64)
  Title: Enrollment ID

  The unique identifier of the partner enrollment.
• PartnerEnrollmentNumber: string
  Title: Enrollment Number

  The surrogate key for partner enrollment.
• PartnerPartyId: integer (int64)
  Title: Partner Party ID

  The party identifier of the partner organization.
• PartnerPartyName: string
  Title: Partner

  Maximum Length: 80

  The party name of the partner organization.
• PartnerPartyNumber: string
  Title: Partner Number

  The partner party number of partner associated with the activity.
• PartnerProgramId: integer (int64)
  Title: Partner Program ID

  The related partner program.
• PartnerProgramName: string
  Title: Program

  The name of partner program associated to the activity.
• PartnerProgramNumber: string
  Title: Program Number

  The partner program number of partner program associated with the activity.
• PartnerUsageFlag: boolean
  Title: Partner Usage

  Maximum Length: 1

  Default Value: false

  Flag to indicate that the Activity has been created for an Organization Account with usage as Partner.
• PercentageComplete: number
  Title: Percentage Complete

  Default Value: 0

  The numeric value 0 to100 to reflect the percent complete status of the activity. Free form numeric. Percentage value at end.
• PrimaryContactEmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  Hold the email identifier of the primary contact.
• PrimaryContactId: integer (int64)
  Title: Primary Contact ID

  The primary contact of the activity.
• PrimaryContactName: string
  Title: Primary Contact

  The name of the primary contact.
• PrimaryContactNameOsn: string
  Title: Social Primary Contact Name

  The contact name displayed in Oracle Social Network.
• PrimaryFormattedAddress: string
  Title: Primary Contact Address

  Read Only: true

  The address of the primary contact.
• PrimaryFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The phone number of the primary contact.
• PriorityCode: string
  Title: Priority

  Maximum Length: 30

  The priority of the activity. Default to 2. Possible values: 1, 2, 3.
• PrivateFlag: boolean
  Title: Private

  Maximum Length: 1

  Indicates whether the activity is private.
• RecordSet: string
  Title: Record Set

  Maximum Length: 255

  The record set of the activity.
• RecurDay: integer (int64)
  Title: Day

  Repeat on specified day of month for monthly appointments.
• RecurEndDate: string (date-time)
  Title: Ends

  Ends on a specified date.
• RecurEveryOptionFlag: boolean
  Title: Recurrence Option

  Maximum Length: 1

  It's set to indicate if the recurrence occurs for every day, month, year, and so on. For example, a daily recurring appointment can occur every day of the week or weekdays only. If it's everyday of the week, it's set to Y if it's weekdays only, it's set to N.
• RecurExceptionFlag: boolean
  Title: Recurrence Exception

  Maximum Length: 1

  Indicates if appointment instance has been updated outside of recurring appointment series.
• RecurFrequency: number
  Title: Repeat

  Frequency that the recurring appointment series repeats.
• RecurFriFlag: boolean
  Title: Friday

  Maximum Length: 1

  Repeat on Friday.
• RecurMonFlag: boolean
  Title: Monday

  Maximum Length: 1

  Repeat on Monday.
• RecurMonth: string
  Title: Month

  Maximum Length: 30

  Repeat on specified month (for yearly appointments).
• RecurNumberOfInstances: number
  Title: Number of Instances

  Designates specific number of occurrences for the series to end after.
• RecurOrigInstDate: string (date-time)
  Title: Original Instance Date

  Original date of a recurring appointment instance.
• RecurPattern: string
  Title: Pattern

  Maximum Length: 30

  Designates which week for appointment to recur for monthly and yearly appointments. Possible values: First, Second, Third, Fourth, Last.
• RecurRecType: string
  Title: Recurrence Record Type

  Maximum Length: 1

  Default Value: N

  For Internal Use Only. Either I for instance or S for series or N for nonrecurring. Don't populate it if Activity is of type Task.
• RecurSatFlag: boolean
  Title: Saturday

  Maximum Length: 1

  Repeat on Saturday.
• RecurSeriesId: integer (int64)
  Title: Recurrence Series ID

  Series Id that links instances of a series together.
• RecurSunFlag: boolean
  Title: Sunday

  Maximum Length: 1

  Repeat on Sunday.
• RecurThuFlag: boolean
  Title: Thursday

  Maximum Length: 1

  Repeat on Thursday.
• RecurTueFlag: boolean
  Title: Tuesday

  Maximum Length: 1

  Repeat on Tuesday.
• RecurTypeCode: string
  Title: Recurrence Type

  Maximum Length: 30

  Designates how often an appointment is repeated. Possible values: Daily, Weekly, Monthly, Yearly.
• RecurUpdatedAttributes: string
  Title: Recurrence Updated Attributes

  Maximum Length: 4000

  The updated field references for recurring appointment exception records.
• RecurWedFlag: boolean
  Title: Wednesday

  Maximum Length: 1

  Repeat on Wednesday.
• RecurWeekday: string
  Title: Pattern Type

  Maximum Length: 30

  It works in conjunction with RecurPattern attribute. Possible values: Monday to Sunday, Weekday, Weekend, Day.
• ReferenceCustomerActTypeCode: string
  Title: Reference Customer Activity Type

  Maximum Length: 30

  The activity type for a reference customer activity. To be used as an extension only.
• ReferenceCustomerId: integer (int64)
  Title: Reference Customer

  The identifier of the reference customer party associated with the activity.
• ReminderPeriod: string
  Title: Set Reminder

  The reminder period.
• ResourceNumber: string
  Title: Resource Number

  Read Only: true

  Maximum Length: 30

  The resource number of owner associated with the activity.
• ResponseCode: string
  Title: Response

  The response code.
• SalesObjectiveName: string
  Title: Sales Objective

  The sales objective name associated to the activity.
• SalesObjectiveNumber: string
  Title: Sales Objective Number

  The sales objective number of the sales objective associated with the activity.
• SearchDate: string (date-time)
  The date filter used in search.
• SelectedFlag: boolean
  Default Value: false

  The records selected for Mass Update.
• ShowStatus: string
  Title: Show

  Maximum Length: 255

  Indicates whether the activity is open, complete, or all activities.
• ShowTimeAs: string
  Title: Show Time As

  The show time of the activity.
• SmartActionContext: string
  Title: Smart Action Context

  Maximum Length: 4000

  Stores metadata needed for smart action.
• SmartActionId: integer (int64)
  Title: Smart Action ID

  The smart action Identifier. Foreign key from zca_user_action.
• smartActions: array Smart Actions
  Title: Smart Actions

  This VO stores the endpoint and security details for every user action.
• SortDate: string (date-time)
  Title: Date

  This is an internal column which is used to sort the activity based on the due date for task and start date for activity.
• SourceObjectCode: string
  The code of the object to which activity will get related to.
• SourceObjectId: integer
  The identifier of the object to which activity will get related to.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the service request.
• SrNumber: string
  Title: Service Request

  The service request number.
• StartDateForCallReport: string (date-time)
  The start date of the call report.
• StartDateForCallReportAttr: string (date-time)
  The attribute for start date of the call report.
• StartDtRFAttr: string (date-time)
  The attribute for activity start date.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Status of the activity. Defaulted to NOT_STARTED.
• Subject: string
  Title: Subject

  Maximum Length: 500

  The subject of the activity.
• SubmittedBy: integer (int64)
  Title: Submitted By

  The call report submitter.
• SubmittedByName: string
  Title: Submitted By

  Maximum Length: 255

  The name of the call report submitter.
• SubmittedDate: string (date-time)
  Title: Submitted Date

  The call report submission date.
• SwitchCallId: string
  Title: Switch Call ID

  Maximum Length: 128

  The unique identifier of the call on the external phone system.
• TaskReminderPeriod: string
  Title: Due Date Reminder

  The task reminder period.
• TemplateDuration: number
  Title: Template Duration

  The duration in days of the template activity. This attribute is used with the start date when generating an activity from a template to calculate the due date.
• TemplateFlag: string
  Title: Template

  Maximum Length: 1

  Default Value: N

  Indicates whether this is a template activity.
• TemplateId: integer (int64)
  Title: Template ID

  The unique identifier of the template associated to the activity.
• TemplateLeadTime: number
  Title: Lead Time

  The lead time in days of the template activity. This attribute is used with the date input parameter when generating an activity from a template to calculate the activity start date. Activity start date is equal date provided as input parameter and lead time.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the user has access to update the record.
• UpgSourceObjectId: string
  Read Only: true

  Maximum Length: 64

  The unique identifier for source object.
• UpgSourceObjectType: string
  Read Only: true

  Maximum Length: 30

  The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record.
• WebConferenceDetails: string (byte)
  Title: Web Conference Details

  The web conference details.
• WebConferenceId: string
  Title: Web Conference ID

  Maximum Length: 255

  The unique identifier of the web conference.
• WebConferenceURL: string
  Title: Web Conference URL

  Maximum Length: 2000

  The web conference join URL.
• WebconfSyncStatusFlag: boolean
  Title: Web Conference Synchronization

  Maximum Length: 1

  The appointment interaction status.

{
    "type":"object",
    "properties":{
        "AccountAddress":{
            "title":"Account Address",
            "type":"string",
            "description":"The address of the account associated with the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountId":{
            "title":"Account ID",
            "type":"integer",
            "description":"The unique identifier of the account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountIdAttr":{
            "type":"integer",
            "description":"The attribute for the account identifier. This attribute isn't for public usage.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account",
            "type":"string",
            "description":"The name of the account associated to activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AccountNameOsn":{
            "title":"Social Account Name",
            "type":"string",
            "description":"The account name displayed in Oracle Social Network.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AccountName"
                ]
            }
        },
        "AccountNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The account number of the account associated with the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountPhoneNumber":{
            "title":"Account Phone Number",
            "type":"string",
            "description":"The phone number of the account associated with the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The status of the account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of the account.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityCreatedBy":{
            "title":"Activity Created By",
            "maxLength":64,
            "type":"string",
            "description":"The activity user who created the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityCreationDate":{
            "title":"Activity Creation Date",
            "type":"string",
            "description":"The date when the activity was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityDescription":{
            "title":"Description",
            "type":"string",
            "description":"A text field for capturing some descriptive information about the activity.",
            "format":"byte",
            "nullable":true,
            "x-hints":{
                "protectionKey":"ActivityEO.ActivityDesc",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "ActivityDirection":{
            "type":"string",
            "description":"The code indicating the direction of an activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DirectionCode"
                ]
            }
        },
        "ActivityEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date and time of an appointment, or the completion time of a task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityFilter":{
            "type":"string",
            "description":"An attribute to add additional activity filter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityFunctionCode":{
            "title":"Activity",
            "maxLength":30,
            "type":"string",
            "description":"The task vs appointment. This is for system use only.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActivityFunctionCodeTrans":{
            "title":"Activity",
            "maxLength":255,
            "type":"string",
            "description":"The activity function code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"System generated nonnullable primary key of the table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActivityLastUpdateLogin":{
            "title":"Activity Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Original Activity Last Update Login",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityMtgMinutes":{
            "title":"Meeting Minutes",
            "type":"string",
            "description":"The activity meeting minutes.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityNumber":{
            "title":"Activity Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the activity.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityOutcome":{
            "type":"string",
            "description":"The outcome of the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OutcomeCode"
                ]
            }
        },
        "ActivityPartialDescription":{
            "title":"Short Description",
            "maxLength":4000,
            "type":"string",
            "description":"A column that stores the first 4000 characters of activity description.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityPriority":{
            "title":"Priority",
            "type":"string",
            "description":"Indicates the priority of the activity. This attribute isn't for public usage.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PriorityCode"
                ]
            }
        },
        "ActivityStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date and time of an appointment or a task. Defaulted to null for an appointment and defaulted to creation date time for a task.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityStatus":{
            "title":"Status",
            "type":"string",
            "description":"Indicates the status of the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivitySubtypeCode":{
            "title":"Subtype",
            "maxLength":30,
            "type":"string",
            "description":"Displays a list of subtype values that are dependent on the value of the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ActivityTypeCode",
                    "ActivityFunctionCode"
                ]
            },
            "x-queryable":true
        },
        "ActivityTimezone":{
            "type":"string",
            "description":"Represents the time zone that the activity needs to be created in, other than the default logged in user's timezone preference.",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityType":{
            "title":"Activity Type",
            "type":"string",
            "description":"The type of the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ActivityTypeCode"
                ]
            }
        },
        "ActivityTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type or category of the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "AttributeType":"Picklist",
                "Dependencies":"ActivityFunctionCode"
            },
            "x-queryable":true
        },
        "ActivityUpdateDate":{
            "title":"Activity Updated Date",
            "type":"string",
            "description":"The date when the activity was updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityUpdatedBy":{
            "title":"Activity Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who updated the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActivityUserLastUpdateDate":{
            "title":"Activity User Last Updated Date",
            "type":"string",
            "description":"The date when the activity was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AllDayFlag":{
            "title":"All Day",
            "maxLength":1,
            "type":"boolean",
            "description":"Designates that an appointment is the entire day.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "AppointmentStatus":{
            "title":"Appointment Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the appointment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ApptEndTime":{
            "title":"End Time",
            "type":"string",
            "description":"Indicates the appointment end time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ApptStartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"Indicates the appointment start time.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "ArticleVersionId":{
            "title":"Article Version ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the article version.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentId":{
            "title":"Assessment ID",
            "type":"integer",
            "description":"The unique identifier of the assessment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetName":{
            "title":"Asset",
            "type":"string",
            "description":"The name of the asset.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "type":"string",
            "description":"The alternate identifier of the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "maxLength":100,
            "type":"string",
            "description":"The serial number of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the attachment entity.",
            "nullable":true,
            "default":"ZMM_ACTY_ACTIVITIES",
            "x-queryable":false
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-Activity-Attachments-item-response"
            }
        },
        "AutoLogSource":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"For activities auto-generated through other systems, store the source system where it came from. We will use this information later in sync back logic to avoid double appearances of the same activity.",
            "nullable":true,
            "x-queryable":true
        },
        "BpId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The unique identifier of the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BuOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier for the Business Unit. This attribute is obsolete.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessPlanName":{
            "title":"Business Plan",
            "type":"string",
            "description":"The business plan name associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "type":"string",
            "description":"The business plan number of the business plan associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "CalendarAccess":{
            "type":"boolean",
            "description":"The access rights to calendar. This isn't for public usage.",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarRecurType":{
            "type":"string",
            "description":"The activity recurrence type.",
            "nullable":true,
            "x-queryable":true
        },
        "CalendarSubject":{
            "type":"string",
            "description":"The activity subject.",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarSubjectDay":{
            "type":"string",
            "description":"The title of the calendar.",
            "nullable":true,
            "x-queryable":false
        },
        "CalendarTimeType":{
            "type":"string",
            "description":"Indicates all day appointment. This isn't for public usage.",
            "nullable":true,
            "x-queryable":true
        },
        "CallReportCount":{
            "title":"Call Report Count",
            "type":"integer",
            "description":"Indicates the number of call reports.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CallReportUpcomingYN":{
            "type":"string",
            "description":"Indicates Y,N,M for upcoming appointments.",
            "nullable":true,
            "x-queryable":true
        },
        "CallReportYN":{
            "type":"string",
            "description":"Flag to Check if this activity has a Call Report",
            "nullable":true,
            "x-queryable":true
        },
        "CampaignId":{
            "title":"Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CampaignName":{
            "title":"Campaign",
            "type":"string",
            "description":"The name of the campaign associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CampaignId"
                ]
            },
            "x-queryable":true
        },
        "CampaignNumber":{
            "title":"Campaign Number",
            "type":"string",
            "description":"The campaign number of the campaign associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "CaseId":{
            "title":"Case ID",
            "type":"integer",
            "description":"The unique identifier of the case.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CaseNumber":{
            "title":"Case Number",
            "type":"string",
            "description":"The alternate identifier of the case.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "CaseId"
                ]
            },
            "x-queryable":true
        },
        "CaseTitle":{
            "title":"Title",
            "maxLength":400,
            "type":"string",
            "description":"The title of the case.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckedInBy":{
            "title":"Checked-In By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the person who checks-in to a location.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckedOutBy":{
            "title":"Checked-Out By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the person who checks-out to a location.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckinDate":{
            "title":"Check-In Time",
            "type":"string",
            "description":"Stores the date and time when a user checks in to an appointment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CheckinLatitude":{
            "title":"Check-In Latitude",
            "type":"number",
            "description":"Stores the latitude of a location where a user checks in to an appointment.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckinLongitude":{
            "title":"Check-In Longitude",
            "type":"number",
            "description":"Stores the longitude of a location where a user checks in to an appointment.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckoutDate":{
            "title":"Check-Out Time",
            "type":"string",
            "description":"Stores the date and time when a user checks out of an appointment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CheckoutLatitude":{
            "title":"Check-Out Latitude",
            "type":"number",
            "description":"Stores the latitude of a location where a user checks out of an appointment.",
            "nullable":true,
            "x-queryable":true
        },
        "CheckoutLongitude":{
            "title":"Check-Out Longitude",
            "type":"number",
            "description":"Stores the longitude of a location where a user checks out of an appointment.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimId":{
            "title":"Claim ID",
            "type":"integer",
            "description":"The unique identifier of the claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ClaimName":{
            "title":"MDF Claim",
            "type":"string",
            "description":"The name associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ClaimNumber":{
            "title":"Claim Number",
            "type":"string",
            "description":"The number of the claim associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier of the conflict. This attribute isn't for public usage.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactIDAttr":{
            "type":"integer",
            "description":"The contact identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The contact number of primary contact associated with the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code from profile.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Attribute to capture the Date and Time the activity was created. This is defaulted by the application.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate",
            "maxLength":30,
            "type":"string",
            "description":"Holds the currency code of a record.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"Holds the currency conversion rate type from profile.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "CurrentDateForCallReport":{
            "type":"string",
            "description":"Indicates the current date for the call report.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentDateForCallReportAttr":{
            "type":"string",
            "description":"The attribute for the current date for the call report. This isn't for public usage.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentSystemDtTransient":{
            "type":"string",
            "description":"The current system date.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "title":"Customer Account ID",
            "type":"integer",
            "description":"The unique identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DealId":{
            "title":"Deal ID",
            "type":"integer",
            "description":"The unique identifier of the related deal.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DealNumber":{
            "title":"Deal Registration",
            "type":"string",
            "description":"The deal number associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "DelegatorId":{
            "title":"Delegator ID",
            "type":"integer",
            "description":"The activity resource that delegated activity ownership to another resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DelegatorName":{
            "title":"Delegated By",
            "type":"string",
            "description":"The name of activity resource that delegated activity ownership to another resource.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DerivedAccountId":{
            "type":"integer",
            "description":"The unique identifier of the derived account.",
            "nullable":true,
            "x-queryable":false
        },
        "DirectionCode":{
            "title":"Direction",
            "maxLength":30,
            "type":"string",
            "description":"The inbound or outbound. It's optional. The default is null.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DismissAssignee":{
            "title":"Dismissed",
            "type":"string",
            "description":"Indicates whether the assignees is dismissed. Valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "DismissFlag":{
            "title":"Dismissed",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this activity is dismissed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DoNotCallFlag":{
            "type":"boolean",
            "description":"Flag to indicate if primary Contact can be called.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The date the task activity is due to be completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Duration":{
            "title":"Duration",
            "type":"number",
            "description":"The duration of an appointment or task.",
            "nullable":true,
            "x-queryable":false
        },
        "DynamicClaimLOVSwitcher":{
            "type":"string",
            "description":"The dynamic claim switcher.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailSentDate":{
            "type":"string",
            "description":"This field is used to capture the Activity Email Notification shared date for Outlook integration.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateForCallReport":{
            "type":"string",
            "description":"The end date of the call report.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateForCallReportAttr":{
            "type":"string",
            "description":"The attribute for end date of the call report. This isn't for public use.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EndDtRFAttr":{
            "type":"string",
            "description":"The attribute for activity start date. This isn't for public use.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalContactEmail":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of an external contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalContactName":{
            "title":"External Contact Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of an external contact.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternallyOwnedFlag":{
            "title":"Externally Owned",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the activity isn't created by an internal resource.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "FundRequestId":{
            "title":"Fund Request ID",
            "type":"integer",
            "description":"The unique identifier of the fund request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FundRequestName":{
            "title":"MDF Request",
            "type":"string",
            "description":"The fund request name associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "FundRequestNumber":{
            "title":"Fund Request Number",
            "type":"string",
            "description":"The fund request number of the fund request associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "IbAssetId":{
            "title":"IB Asset ID",
            "type":"integer",
            "description":"The unique identifier of the installed base asset associated with the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IbAssetNumber":{
            "title":"Installed Base Asset",
            "type":"string",
            "description":"The number of the installed base asset associated with the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "IbAssetSerialNumber":{
            "title":"Installed Base Asset Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"The serial number of the installed base asset associated with the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InstNumDerivedFrom":{
            "type":"string",
            "description":"The attribute to identify recurrence mode. This isn't for public use.",
            "nullable":true,
            "default":"Y",
            "x-queryable":false
        },
        "IsClientService":{
            "type":"string",
            "description":"The obsolete attribute. This isn't for public use.",
            "nullable":true,
            "default":"Y",
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The attribute to capture the date and time the activity was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":32,
            "type":"string",
            "description":"The attribute to capture the identifiers of the user who last updated the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The attribute to capture the identifier of the user who last updated the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"Indicates the related lead to the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeadIdAttr":{
            "type":"integer",
            "description":"The attribute for the lead identifier. This isn't for public use.",
            "nullable":true,
            "x-queryable":true
        },
        "LeadName":{
            "title":"Lead",
            "type":"string",
            "description":"Indicates the lead name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "LeadId"
                ]
            },
            "x-queryable":true
        },
        "LeadNameOsn":{
            "title":"Social Lead Name",
            "type":"string",
            "description":"The lead name displayed in Oracle Social Network.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "LeadName"
                ]
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "type":"string",
            "description":"The lead number of lead associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "Location":{
            "title":"Location",
            "maxLength":200,
            "type":"string",
            "description":"Indicates the location of an appointment.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"The location or address ID of the activity account or primary contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LoginUserRFAttr":{
            "type":"integer",
            "description":"The attribute for activity login user. This isn't for public use.",
            "nullable":true,
            "x-queryable":true
        },
        "MdfRequestId":{
            "type":"integer",
            "description":"The identifier for fund request.",
            "nullable":true,
            "x-queryable":false
        },
        "MobileActivityCode":{
            "title":"Mobile Activity Code",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of external mobile device.",
            "nullable":true,
            "x-queryable":false
        },
        "NotesLinkSourceCodeTransient":{
            "type":"string",
            "description":"The note source object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier of the objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OpportunityId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the related opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OpportunityIdAttr":{
            "type":"integer",
            "description":"The attribute for the opportunity identifier. This isn't for public use.",
            "nullable":true,
            "x-queryable":true
        },
        "OpportunityName":{
            "title":"Opportunity",
            "type":"string",
            "description":"The name of opportunity associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "OpportunityId"
                ]
            },
            "x-queryable":true
        },
        "OpportunityNameOsn":{
            "title":"Social Opportunity Name",
            "type":"string",
            "description":"The opportunity name displayed in Oracle Social Network.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OpportunityName"
                ]
            }
        },
        "OpportunityNumber":{
            "title":"Opportunity Number",
            "type":"string",
            "description":"The opportunity number of the opportunity associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier to identify the orchestration process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier to identify the orchestration step.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrigEntityCode":{
            "maxLength":30,
            "type":"string",
            "description":"The column to store the source of activity record during upgrade.",
            "nullable":true,
            "default":"ACTIVITY",
            "x-queryable":false
        },
        "OrigEntityNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The column to store the original user key of the object being upgraded to activity.",
            "nullable":true,
            "x-queryable":false
        },
        "OsnActivityId":{
            "type":"integer",
            "description":"The unique identifier for an activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OtherPartyPhoneNumber":{
            "title":"Other Party Phone Number",
            "maxLength":40,
            "type":"string",
            "description":"For inbound phone calls, the ANI or number being called from. For outbound calls, the phone number being called.",
            "nullable":true,
            "x-queryable":true
        },
        "OutcomeCode":{
            "title":"Outcome",
            "maxLength":30,
            "type":"string",
            "description":"The code of the outcome of the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OutlookAutoSyncFlag":{
            "title":"Microsoft Auto-Synchronization",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an appointment was automatically generated by the synchronization process from Microsoft 365.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "OutlookFlag":{
            "title":"Outlook",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity was created from Outlook and synced.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "OutlookGlobalId":{
            "title":"Outlook Global ID",
            "maxLength":1024,
            "type":"string",
            "description":"The unique identifier of an appointment created from Microsoft 365.",
            "nullable":true,
            "x-queryable":true
        },
        "OutlookIdentifier":{
            "title":"Outlook Identifier",
            "maxLength":1024,
            "type":"string",
            "description":"The unique identifier from outlook activity.",
            "nullable":true,
            "x-queryable":true
        },
        "OwnerAddress":{
            "title":"Activity Owner Address",
            "type":"string",
            "description":"The activity owner's address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerEmailAddress":{
            "title":"Activity Owner Email",
            "maxLength":320,
            "type":"string",
            "description":"The activity owner's email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The primary resource on the activity. Supports resources only.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of primary resource of activity.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "OwnerNameOsn":{
            "title":"Social Owner Name",
            "type":"string",
            "description":"The owner name displayed in Oracle Social Network.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "OwnerName"
                ]
            }
        },
        "OwnerPhoneNumber":{
            "title":"Activity Owner Phone Number",
            "type":"string",
            "description":"The activity owner's phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParentActivityId":{
            "title":"Parent ID",
            "type":"integer",
            "description":"The related activity identifier, only applicable if the record is a follow up activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentActivityIdAttr":{
            "type":"string",
            "description":"The attribute for the parent activity identifier. This isn't for public use.",
            "nullable":true,
            "x-queryable":true
        },
        "PartialMtgMinutes":{
            "title":"Short Meeting Minutes",
            "maxLength":4000,
            "type":"string",
            "description":"A column that stores a truncated string of the meeting minutes.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerEnrollmentId":{
            "title":"Enrollment ID",
            "type":"integer",
            "description":"The unique identifier of the partner enrollment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerEnrollmentNumber":{
            "title":"Enrollment Number",
            "type":"string",
            "description":"The surrogate key for partner enrollment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PartnerPartyId":{
            "title":"Partner Party ID",
            "type":"integer",
            "description":"The party identifier of the partner organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerPartyName":{
            "title":"Partner",
            "maxLength":80,
            "type":"string",
            "description":"The party name of the partner organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PartnerPartyNumber":{
            "title":"Partner Number",
            "type":"string",
            "description":"The partner party number of partner associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerProgramId":{
            "title":"Partner Program ID",
            "type":"integer",
            "description":"The related partner program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerProgramName":{
            "title":"Program",
            "type":"string",
            "description":"The name of partner program associated to the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PartnerProgramId"
                ]
            }
        },
        "PartnerProgramNumber":{
            "title":"Program Number",
            "type":"string",
            "description":"The partner program number of partner program associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerUsageFlag":{
            "title":"Partner Usage",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to indicate that the Activity has been created for an Organization Account with usage as Partner.",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "PercentageComplete":{
            "title":"Percentage Complete",
            "type":"number",
            "description":"The numeric value 0 to100 to reflect the percent complete status of the activity. Free form numeric. Percentage value at end.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "PrimaryContactEmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"Hold the email identifier of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PrimaryContactId":{
            "title":"Primary Contact ID",
            "type":"integer",
            "description":"The primary contact of the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryContactName":{
            "title":"Primary Contact",
            "type":"string",
            "description":"The name of the primary contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PrimaryContactNameOsn":{
            "title":"Social Primary Contact Name",
            "type":"string",
            "description":"The contact name displayed in Oracle Social Network.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactName"
                ]
            }
        },
        "PrimaryFormattedAddress":{
            "title":"Primary Contact Address",
            "type":"string",
            "description":"The address of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the primary contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PriorityCode":{
            "title":"Priority",
            "maxLength":30,
            "type":"string",
            "description":"The priority of the activity. Default to 2. Possible values: 1, 2, 3.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrivateFlag":{
            "title":"Private",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the activity is private.",
            "nullable":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "RecordSet":{
            "title":"Record Set",
            "maxLength":255,
            "type":"string",
            "description":"The record set of the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RecurDay":{
            "title":"Day",
            "type":"integer",
            "description":"Repeat on specified day of month for monthly appointments.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "RecurEndDate":{
            "title":"Ends",
            "type":"string",
            "description":"Ends on a specified date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RecurEveryOptionFlag":{
            "title":"Recurrence Option",
            "maxLength":1,
            "type":"boolean",
            "description":"It's set to indicate if the recurrence occurs for every day, month, year, and so on. For example, a daily recurring appointment can occur every day of the week or weekdays only. If it's everyday of the week, it's set to Y if it's weekdays only, it's set to N.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurExceptionFlag":{
            "title":"Recurrence Exception",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if appointment instance has been updated outside of recurring appointment series.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurFrequency":{
            "title":"Repeat",
            "type":"number",
            "description":"Frequency that the recurring appointment series repeats.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurFriFlag":{
            "title":"Friday",
            "maxLength":1,
            "type":"boolean",
            "description":"Repeat on Friday.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurMonFlag":{
            "title":"Monday",
            "maxLength":1,
            "type":"boolean",
            "description":"Repeat on Monday.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurMonth":{
            "title":"Month",
            "maxLength":30,
            "type":"string",
            "description":"Repeat on specified month (for yearly appointments).",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RecurNumberOfInstances":{
            "title":"Number of Instances",
            "type":"number",
            "description":"Designates specific number of occurrences for the series to end after.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurOrigInstDate":{
            "title":"Original Instance Date",
            "type":"string",
            "description":"Original date of a recurring appointment instance.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "RecurPattern":{
            "title":"Pattern",
            "maxLength":30,
            "type":"string",
            "description":"Designates which week for appointment to recur for monthly and yearly appointments. Possible values: First, Second, Third, Fourth, Last.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RecurRecType":{
            "title":"Recurrence Record Type",
            "maxLength":1,
            "type":"string",
            "description":"For Internal Use Only. Either I for instance or S for series or N for nonrecurring. Don't populate it if Activity is of type Task.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "RecurSatFlag":{
            "title":"Saturday",
            "maxLength":1,
            "type":"boolean",
            "description":"Repeat on Saturday.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurSeriesId":{
            "title":"Recurrence Series ID",
            "type":"integer",
            "description":"Series Id that links instances of a series together.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecurSunFlag":{
            "title":"Sunday",
            "maxLength":1,
            "type":"boolean",
            "description":"Repeat on Sunday.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurThuFlag":{
            "title":"Thursday",
            "maxLength":1,
            "type":"boolean",
            "description":"Repeat on Thursday.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurTueFlag":{
            "title":"Tuesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Repeat on Tuesday.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurTypeCode":{
            "title":"Recurrence Type",
            "maxLength":30,
            "type":"string",
            "description":"Designates how often an appointment is repeated. Possible values: Daily, Weekly, Monthly, Yearly.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RecurUpdatedAttributes":{
            "title":"Recurrence Updated Attributes",
            "maxLength":4000,
            "type":"string",
            "description":"The updated field references for recurring appointment exception records.",
            "nullable":true,
            "x-queryable":true
        },
        "RecurWedFlag":{
            "title":"Wednesday",
            "maxLength":1,
            "type":"boolean",
            "description":"Repeat on Wednesday.",
            "nullable":true,
            "x-queryable":false
        },
        "RecurWeekday":{
            "title":"Pattern Type",
            "maxLength":30,
            "type":"string",
            "description":"It works in conjunction with RecurPattern attribute. Possible values: Monday to Sunday, Weekday, Weekend, Day.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ReferenceCustomerActTypeCode":{
            "title":"Reference Customer Activity Type",
            "maxLength":30,
            "type":"string",
            "description":"The activity type for a reference customer activity. To be used as an extension only.",
            "nullable":true,
            "x-queryable":false
        },
        "ReferenceCustomerId":{
            "title":"Reference Customer",
            "type":"integer",
            "description":"The identifier of the reference customer party associated with the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReminderPeriod":{
            "title":"Set Reminder",
            "type":"string",
            "description":"The reminder period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceNumber":{
            "title":"Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"The resource number of owner associated with the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResponseCode":{
            "title":"Response",
            "type":"string",
            "description":"The response code.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SalesObjectiveName":{
            "title":"Sales Objective",
            "type":"string",
            "description":"The sales objective name associated to the activity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SalesObjectiveNumber":{
            "title":"Sales Objective Number",
            "type":"string",
            "description":"The sales objective number of the sales objective associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchDate":{
            "type":"string",
            "description":"The date filter used in search.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "SelectedFlag":{
            "type":"boolean",
            "description":"The records selected for Mass Update.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ShowStatus":{
            "title":"Show",
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the activity is open, complete, or all activities.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShowTimeAs":{
            "title":"Show Time As",
            "type":"string",
            "description":"The show time of the activity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SmartActionContext":{
            "title":"Smart Action Context",
            "maxLength":4000,
            "type":"string",
            "description":"Stores metadata needed for smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "SmartActionId":{
            "title":"Smart Action ID",
            "type":"integer",
            "description":"The smart action Identifier. Foreign key from zca_user_action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SortDate":{
            "title":"Date",
            "type":"string",
            "description":"This is an internal column which is used to sort the activity based on the due date for task and start date for activity.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "type":"string",
            "description":"The code of the object to which activity will get related to.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "type":"integer",
            "description":"The identifier of the object to which activity will get related to.",
            "nullable":true,
            "x-queryable":false
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrNumber":{
            "title":"Service Request",
            "type":"string",
            "description":"The service request number.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "SrId"
                ]
            },
            "x-queryable":true
        },
        "StartDateForCallReport":{
            "type":"string",
            "description":"The start date of the call report.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StartDateForCallReportAttr":{
            "type":"string",
            "description":"The attribute for start date of the call report.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StartDtRFAttr":{
            "type":"string",
            "description":"The attribute for activity start date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Status of the activity. Defaulted to NOT_STARTED.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Subject":{
            "title":"Subject",
            "maxLength":500,
            "type":"string",
            "description":"The subject of the activity.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"ActivityEO.Subject",
                "protectionState":"TOKENIZED"
            },
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "type":"integer",
            "description":"The call report submitter.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SubmittedByName":{
            "title":"Submitted By",
            "maxLength":255,
            "type":"string",
            "description":"The name of the call report submitter.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SubmittedDate":{
            "title":"Submitted Date",
            "type":"string",
            "description":"The call report submission date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SwitchCallId":{
            "title":"Switch Call ID",
            "maxLength":128,
            "type":"string",
            "description":"The unique identifier of the call on the external phone system.",
            "nullable":true,
            "x-queryable":false
        },
        "TaskReminderPeriod":{
            "title":"Due Date Reminder",
            "type":"string",
            "description":"The task reminder period.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TemplateDuration":{
            "title":"Template Duration",
            "type":"number",
            "description":"The duration in days of the template activity. This attribute is used with the start date when generating an activity from a template to calculate the due date.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":3
            }
        },
        "TemplateFlag":{
            "title":"Template",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this is a template activity.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "TemplateId":{
            "title":"Template ID",
            "type":"integer",
            "description":"The unique identifier of the template associated to the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TemplateLeadTime":{
            "title":"Lead Time",
            "type":"number",
            "description":"The lead time in days of the template activity. This attribute is used with the date input parameter when generating an activity from a template to calculate the activity start date. Activity start date is equal date provided as input parameter and lead time.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":3
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpgSourceObjectId":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier for source object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpgSourceObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WebConferenceDetails":{
            "title":"Web Conference Details",
            "type":"string",
            "description":"The web conference details.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "WebConferenceId":{
            "title":"Web Conference ID",
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the web conference.",
            "nullable":true,
            "x-queryable":true
        },
        "WebConferenceURL":{
            "title":"Web Conference URL",
            "maxLength":2000,
            "type":"string",
            "description":"The web conference join URL.",
            "nullable":true,
            "x-queryable":true
        },
        "WebconfSyncStatusFlag":{
            "title":"Web Conference Synchronization",
            "maxLength":1,
            "type":"boolean",
            "description":"The appointment interaction status.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-item-response"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object activityTemplates-Activity-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-Activity-Attachments-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 : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

• Array of: object activityTemplates-Activity-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-item-response"
    }
}

Nested Schema : activityTemplates-Activity-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "help":{
                    "instruction":"The base64 encoded image of the file displayed in .png format if the source is a convertible image."
                },
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "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."
        }
    }
}

Nested Schema : activityTemplates-Activity-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  Consumer-friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  REST Resources the action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The REST endpoint to perform the action.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  List of applications that this action can be used in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Boolean type indicating if this action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  HTTP method to use with HREF.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates if smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Boolean type indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  Attributes to be updated when the Actions UI is launched.
• UserActionId: integer (int64)
  Title: User Action ID

  Uniquely identifies the action. For internal use.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  Uniquely identifies the action with a name. For internal use.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  Number to indicate priority of the action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"Uniquely identifies the action. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionNavigation-item-response"
            }
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionURLBinding-item-response"
            }
        },
        "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 : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object activityTemplates-Activity-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object activityTemplates-Activity-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object activityTemplates-Activity-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/activityTemplates-Activity-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : activityTemplates-Activity-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavId: integer (int64)
  Title: Primary Key

  Primary key for the user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"Application usage.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"Primary key for the user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false,
            "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 : activityTemplates-Activity-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadId: integer (int64)
  Uniquely identifies the payload for smart actions. For internal use.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":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 : activityTemplates-Activity-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  This is a hint for processing the Url Binding runtime.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean indicator.
• URLBindingId: integer (int64)
  Uniquely identifies the URL Bind for smart actions. For internal use.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 256

  For action REST endpoints that require runtime binding, this is the key in the key value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 1000

  For action REST endpoints that require runtime binding, this is the value in the key value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"Uniquely identifies the URL Bind for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":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"
    }
}

Back to Top

Examples

The following example shows how to get all activity templates by submitting a GET request on the REST resource.

cURL Command

curl -u <username:password> \
 -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "items": [
        {
            "TemplateId": 300100561962686,
            "TemplateName": "OrchStage1TaskStep212556340",
            "TemplateDescription": null,
            "SourceObjectCode": "OPPORTUNITY",
            "SubTypeCode": null,
            "SetId": 0,
            "ActiveFlag": true,
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2022-08-11T12:36:56+00:00",
            "LastUpdateDate": "2022-08-11T12:37:24.896+00:00",
            "LastUpdateLogin": "E58B1E23AC7A0A3CE05315C5F20AA00C",
            "LastUpdatedBy": "SALES_ADMIN",
            "ObjectVersionNumber": 1,
            "UserLastUpdateDate": null,
            "TemplateFlag": "Y",
            "OrchestrationId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561962686",
                    "name": "activityTemplates",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561962686",
                    "name": "activityTemplates",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561962686/child/Activity",
                    "name": "Activity",
                    "kind": "collection"
                }
            ]
        },
        {
            "TemplateId": 300100561919546,
            "TemplateName": "OrchStage1TaskStep881639527",
            "TemplateDescription": null,
            "SourceObjectCode": "OPPORTUNITY",
            "SubTypeCode": null,
            "SetId": 0,
            "ActiveFlag": true,
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2022-08-11T05:39:34+00:00",
            "LastUpdateDate": "2022-08-11T05:39:39.285+00:00",
            "LastUpdateLogin": "E58B1E238A310A3CE05315C5F20AA00C",
            "LastUpdatedBy": "SALES_ADMIN",
            "ObjectVersionNumber": 1,
            "UserLastUpdateDate": null,
            "TemplateFlag": "Y",
            "OrchestrationId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561919546",
                    "name": "activityTemplates",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561919546",
                    "name": "activityTemplates",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561919546/child/Activity",
                    "name": "Activity",
                    "kind": "collection"
                }
            ]
        },
        {
            "TemplateId": 300100561955943,
            "TemplateName": "OrchStage2AppStep212556340",
            "TemplateDescription": null,
            "SourceObjectCode": "OPPORTUNITY",
            "SubTypeCode": null,
            "SetId": 0,
            "ActiveFlag": true,
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2022-08-11T12:37:38+00:00",
            "LastUpdateDate": "2022-08-11T12:37:45.042+00:00",
            "LastUpdateLogin": "E58B27BB23820A56E05315C5F20AEBB3",
            "LastUpdatedBy": "SALES_ADMIN",
            "ObjectVersionNumber": 1,
            "UserLastUpdateDate": null,
            "TemplateFlag": "Y",
            "OrchestrationId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561955943",
                    "name": "activityTemplates",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561955943",
                    "name": "activityTemplates",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561955943/child/Activity",
                    "name": "Activity",
                    "kind": "collection"
                }
            ]
        },
        {
            "TemplateId": 300100561932521,
            "TemplateName": "OrchStage2AppStep881639527",
            "TemplateDescription": null,
            "SourceObjectCode": "OPPORTUNITY",
            "SubTypeCode": null,
            "SetId": 0,
            "ActiveFlag": true,
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2022-08-11T05:39:45+00:00",
            "LastUpdateDate": "2022-08-11T05:39:46.068+00:00",
            "LastUpdateLogin": "E58B278CA1710A4CE05315C5F20ABCCD",
            "LastUpdatedBy": "SALES_ADMIN",
            "ObjectVersionNumber": 1,
            "UserLastUpdateDate": null,
            "TemplateFlag": "Y",
            "OrchestrationId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561932521",
                    "name": "activityTemplates",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561932521",
                    "name": "activityTemplates",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561932521/child/Activity",
                    "name": "Activity",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 4,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates",
            "name": "activityTemplates",
            "kind": "collection"
        }
    ]
}

Back to Top