Get an Event
get
/crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}
Request
Path Parameters
-
EventNumber: string
Identifier to Events
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : autoEvents-item
Type:
Show Source
object
-
Attachments(optional):
array Attachments
Title:
Attachments
The attachments resource is used to view, create, update, or delete attachments of an event. -
AttributeCategory(optional):
string
Title:
Attribute Category
Maximum Length:30
A system-generated read-only attribute used by the application framework. -
CorpCurrencyCode(optional):
string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the record. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the attachment. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the attachment record was created. -
CurcyConvRateType(optional):
string
Title:
Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the record. -
CurrencyCode(optional):
string
Title:
Currency Code
Maximum Length:15
The currency code associated with the record like USD or EUR. -
DeleteFlag(optional):
boolean
Indicates whether the user has access to delete the record.
-
Description(optional):
string
Title:
Description
Maximum Length:4000
The description of the attachment. -
EventAttendees(optional):
array Event Attendees
Title:
Event Attendees
The event attendees resource is used to view, create, update, or delete an event attendee. -
EventBudget(optional):
number
Title:
Budget
Indicates the budget allocated for the event. -
EventCapacity(optional):
integer(int64)
Title:
Capacity
Indicates the total capacity of event. -
EventDate(optional):
string(date-time)
Title:
Date
The date and time when the event is conducted. -
EventFeedback(optional):
string
Title:
Feedback
Maximum Length:4000
The feedback of the event. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier of event. -
EventInvitations(optional):
array Event Invitations
Title:
Event Invitations
The event invitations resource is used to view, create, update, or delete an event invitation. -
EventName(optional):
string
Title:
Name
Maximum Length:400
The name of the event. -
EventNumber(optional):
string
Title:
Event
Maximum Length:30
The public unique identifier of the event. -
EventOwnerId(optional):
integer(int64)
Title:
Owner ID
The unique identifier of the owner of the event. -
EventTasks(optional):
array Event Tasks
Title:
Event Tasks
The event tasks resource is used to view, create, update, or delete an event task. -
EventType(optional):
string
Title:
Type
Maximum Length:400
The type of the event. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the event was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the event. -
LastUpdateLogin(optional):
string
Title:
Last Update Login
Maximum Length:32
The login of the user who last updated the event. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectVersionNumber(optional):
integer(int32)
Title:
Object Version Number
A system-generated read-only attribute used by the application framework. -
OrgId(optional):
integer(int64)
Title:
Business Unit
The business unit associated with event. -
OriginSystem(optional):
string
Title:
Origin System
Maximum Length:400
The application from where the order originated. -
OriginSystemReference(optional):
string
Title:
Origin System Reference
Maximum Length:400
The unique identifier of the record in the source application. -
UpdateFlag(optional):
boolean
Indicates whether the user has access to update the record.
- EventType LOV
-
Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, update, or delete attachments of an event.
Show Source
Nested Schema : Event Attendees
Type:
array
Title:
Event Attendees
The event attendees resource is used to view, create, update, or delete an event attendee.
Show Source
Nested Schema : Event Invitations
Type:
array
Title:
Event Invitations
The event invitations resource is used to view, create, update, or delete an event invitation.
Show Source
Nested Schema : Event Tasks
Type:
array
Title:
Event Tasks
The event tasks resource is used to view, create, update, or delete an event task.
Show Source
Nested Schema : autoEvents-Attachments-item
Type:
Show Source
object
-
AsyncTrackerId(optional):
string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId(optional):
integer(int64)
Title:
Attached Document Id
The unique identifier of the attachment. -
CategoryName(optional):
string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared(optional): boolean
-
CreatedBy(optional):
string
Title:
Created By
Maximum Length:255
The user who created the record. -
CreatedByUserName(optional):
string
Title:
Created By User Name
The user name who created the record. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the record was created. -
DatatypeCode(optional):
string
Title:
Type
Maximum Length:30
A value that indicates the data type. -
Description(optional):
string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId(optional):
string
Maximum Length:
255
The unique identifier of the document from which the attachment is created. -
DmFolderPath(optional):
string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber(optional):
string
Maximum Length:
255
The document version number from which the attachment is created. -
ErrorStatusCode(optional):
string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage(optional):
string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate(optional):
string(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents(optional):
string(binary)
Title:
File Contents
The contents of the attachment. -
FileName(optional):
string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl(optional):
string
Title:
File Url
The URI of the file. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Update Date
The date and time when the record was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName(optional):
string
Title:
Last Updated By User
The user who last updated the record. -
links(optional):
array Items
Title:
Items
Link Relations -
Title(optional):
string
Title:
Title
The title of the attachment. -
UploadedFileContentType(optional):
string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength(optional):
integer(int64)
Title:
File Size
The size of the attachment file. -
UploadedFileName(optional):
string
Title:
Uploaded File Name
The name assigned to a new attachment file. -
UploadedText(optional):
string
Title:
Uploaded Text
The text of the attachment. -
Uri(optional):
string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url(optional):
string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName(optional):
string
Title:
User Name
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : autoEvents-EventAttendees-item
Type:
Show Source
object
-
AttendeeNumber(optional):
string
Title:
Attendee
Maximum Length:30
The event attendees resource is used to view, create, update, or delete an event attendee. -
AttendeeStatus(optional):
string
Title:
Status
Maximum Length:30
The status of the attendee. -
AttributeCategory(optional):
string
Title:
Attribute Category
Maximum Length:30
A system-generated read-only attribute used by the application framework. -
CorpCurrencyCode(optional):
string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the record. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the record. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the record was created. -
CurcyConvRateType(optional):
string
Title:
Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the record. -
CurrencyCode(optional):
string
Title:
Currency Code
Maximum Length:15
The currency code associated with the record like USD or EUR. -
CustomerId(optional):
integer(int64)
Title:
Customer ID
The unique identifier of the customer. -
EmailAddress(optional):
string
Title:
Email
Maximum Length:100
Email Id of the guest. -
EventAttendeeId(optional):
integer(int64)
Title:
Event Attendee ID
The unique identifier of event attendee. -
EventFeedbackId(optional):
integer(int64)
Title:
Feedback ID
The unique identifier of event feedback. -
EventFeedbacks(optional):
array Event Feedback
Title:
Event Feedback
The event feedbacks resource is used to view, create, update, or delete an event feedback. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier of event. -
GuestFirstName(optional):
string
Title:
First Name
Maximum Length:100
The first name of the guest. -
GuestLastName(optional):
string
Title:
Last Name
Maximum Length:100
The last name of the guest. -
GuestPhoneNumber1(optional):
string
Title:
Mobile Phone 1
Maximum Length:30
The phone number of the guest. -
GuestPhoneNumber2(optional):
string
Title:
Mobile Phone 2
Maximum Length:30
The phone number of the guest. -
GuestPhoneNumber3(optional):
string
Title:
Mobile Phone 3
Maximum Length:30
The phone number of the guest. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the record was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin(optional):
string
Title:
Last Update Login
Maximum Length:32
The login of the user who last updated the record. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectVersionNumber(optional):
integer(int32)
Title:
Object Version Number
A system-generated read-only attribute used by the application framework. -
OrgId(optional):
integer(int64)
Title:
Business Unit
The business unit associated with the record. -
OriginSystem(optional):
string
Title:
Origin System
Maximum Length:400
The application from where the order originated. -
OriginSystemReference(optional):
string
Title:
Origin System Reference
Maximum Length:400
The unique identifier of the record in the source application.
- AttendeeStatus LOV
-
Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups
Nested Schema : Event Feedback
Type:
array
Title:
Event Feedback
The event feedbacks resource is used to view, create, update, or delete an event feedback.
Show Source
Nested Schema : autoEvents-EventAttendees-EventFeedbacks-item
Type:
Show Source
object
-
AttributeCategory(optional):
string
Title:
Attribute Category
Maximum Length:30
A system-generated read-only attribute used by the application framework. -
CorpCurrencyCode(optional):
string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the record. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the record. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the record was created. -
CurcyConvRateType(optional):
string
Title:
Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the record. -
CurrencyCode(optional):
string
Title:
Currency Code
Maximum Length:15
The currency code associated with the record like USD or EUR. -
Description(optional):
string
Title:
Description
Maximum Length:4000
The description of the event. -
EventAttendeeId(optional):
integer(int64)
Title:
Attendee ID
The unique identifier of the attendee. -
EventFeedbackId(optional):
integer(int64)
Title:
Feedback ID
The unique identifier of event feedback. -
EventFeedbackTitle(optional):
string
Title:
Title
Maximum Length:400
The feedback title received for the event. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier of event. -
EventSatisfactionRating(optional):
string
Title:
Satisfaction Rating
Maximum Length:400
The rating that measures how satisfied the attendees are. -
ExternalSurveyURL(optional):
string
Title:
Survey URL
Maximum Length:4000
The survey URL of the event feedback. -
FeedbackNumber(optional):
string
Title:
Feedback
Maximum Length:30
The public unique identifier of the feedback. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the record was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin(optional):
string
Title:
Last Update Login
Maximum Length:32
The login of the user who last updated the record. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectVersionNumber(optional):
integer(int32)
Title:
Object Version Number
A system-generated read-only attribute used by the application framework. -
OrgId(optional):
integer(int64)
Title:
Business Unit
The business unit associated with record. -
OriginSystem(optional):
string
Title:
Origin System
Maximum Length:400
The application from where the order originated. -
OriginSystemReference(optional):
string
Title:
Origin System Reference
Maximum Length:400
The unique identifier of the record in the source application.
Nested Schema : autoEvents-EventInvitations-item
Type:
Show Source
object
-
AttributeCategory(optional):
string
Title:
Attribute Category
Maximum Length:30
A system-generated read-only attribute used by the application framework. -
CorpCurrencyCode(optional):
string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the record. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the record. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the record was created. -
CurcyConvRateType(optional):
string
Title:
Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the record. -
CurrencyCode(optional):
string
Title:
Currency Code
Maximum Length:15
The currency code associated with the record like USD or EUR. -
CustomerId(optional):
integer(int64)
Title:
Customer ID
The unique identifier of the customer. -
EmailAddress(optional):
string
Title:
Email
Maximum Length:100
The email Id of the guest. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier of the event. -
EventInviteId(optional):
integer(int64)
Title:
Event Invite ID
The unique identifier of the event invite. -
GuestFirstName(optional):
string
Title:
First Name
Maximum Length:100
The first name of the guest. -
GuestLastName(optional):
string
Title:
Last Name
Maximum Length:100
The last name of the guest. -
GuestPhoneNumber1(optional):
string
Title:
Mobile Phone 1
Maximum Length:30
The phone number of guest. -
GuestPhoneNumber2(optional):
string
Title:
Mobile Phone 2
Maximum Length:30
The phone number of guest. -
GuestPhoneNumber3(optional):
string
Title:
Mobile Phone 3
Maximum Length:30
The phone number of guest. -
InvitationNumber(optional):
string
Title:
Invitation
Maximum Length:30
The public unique identifier of the invitation. -
InvitationSentDate(optional):
string(date)
Title:
Sent Date
The date when the invitation was sent. -
InvitationStatus(optional):
string
Title:
Status
Maximum Length:30
The status of the invitations. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the record was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin(optional):
string
Title:
Last Update Login
Maximum Length:32
The login of the user who last updated the record. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectVersionNumber(optional):
integer(int32)
Title:
Object Version Number
A system-generated read-only attribute used by the application framework. -
OrgId(optional):
integer(int64)
Title:
Business Unit
The business unit associated with the record. -
OriginSystem(optional):
string
Title:
Origin System Reference
Maximum Length:400
The application from where the order originated. -
OriginSystemReference(optional):
string
Title:
Origin System Reference
Maximum Length:400
The unique identifier of the record in the source application.
- InvitationStatus LOV
-
Method: getPath:
/crmRestApi/resources/11.13.18.05/fndStaticLookups
Nested Schema : autoEvents-EventTasks-item
Type:
Show Source
object
-
AttributeCategory(optional):
string
Title:
Attribute Category
Maximum Length:30
A system-generated read-only attribute used by the application framework. -
CorpCurrencyCode(optional):
string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the event task. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the event task. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date and time when the event task was created. -
CurcyConvRateType(optional):
string
Title:
Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the event task. -
CurrencyCode(optional):
string
Title:
Currency Code
Maximum Length:15
The currency code associated with the event task like USD or EUR. -
EventId(optional):
integer(int64)
Title:
Event ID
The unique identifier of the event. -
EventTaskId(optional):
integer(int64)
Title:
Event Task ID
The unique identifier of the event task. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date and time when the event task was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the event task. -
LastUpdateLogin(optional):
string
Title:
Last Update Login
Maximum Length:32
The login of the user who last updated the event task. -
links(optional):
array Items
Title:
Items
Link Relations -
ObjectVersionNumber(optional):
integer(int32)
Title:
Object Version Number
A system-generated read-only attribute used by the application framework. -
OrgId(optional):
integer(int64)
Title:
Business Unit
The business unit associated with the task. -
OriginSystem(optional):
string
Title:
Origin System
Maximum Length:400
The application where the order originated from. -
OriginSystemReference(optional):
string
Title:
Origin System Reference
Maximum Length:400
The unique identifier of the record in the source application. -
TaskAssigneeId(optional):
integer(int64)
Title:
Assignee
The user to whom the task is assigned. -
TaskDescription(optional):
string
Title:
Description
Maximum Length:400
The description of the task. -
TaskDueDate(optional):
string(date)
Title:
Due Date
The date when the task is due. -
TaskNumber(optional):
string
Title:
Task
Maximum Length:30
The public unique identifier associated with event task. -
TaskTitle(optional):
string
Title:
Title
Maximum Length:100
The title of the task.