Jump to

• Request
• Response

Get an Event Task

get

/crmRestApi/resources/11.13.18.05/autoEvents/{EventNumber}/child/EventTasks/{TaskNumber}

Request

Path Parameters

• EventNumber: string
  Identifier to Events
• TaskNumber: string
  Identifier to Event Tasks

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).

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : autoEvents-EventTasks-item

Type: object

Show Source

• 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.

{
    "properties":{
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Attribute Category"
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code associated with the event task.",
            "title":"Corporate Currency Code"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the event task.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the event task was created.",
            "title":"Creation Date"
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the event task.",
            "title":"Conversion Rate Type"
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the event task like USD or EUR.",
            "title":"Currency Code"
        },
        "EventId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of  the event. ",
            "title":"Event ID"
        },
        "EventTaskId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the event task.",
            "title":"Event Task ID"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the event task was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the event task.",
            "title":"Last Update Login"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the event task.",
            "title":"Last Updated By"
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Object Version Number"
        },
        "OrgId":{
            "format":"int64",
            "type":"integer",
            "description":"The business unit associated with the task.",
            "title":"Business Unit"
        },
        "OriginSystem":{
            "maxLength":400,
            "type":"string",
            "description":"The application where the order originated from.",
            "title":"Origin System"
        },
        "OriginSystemReference":{
            "maxLength":400,
            "type":"string",
            "description":"The unique identifier of the record in the source application.",
            "title":"Origin System Reference"
        },
        "TaskAssigneeId":{
            "format":"int64",
            "type":"integer",
            "description":"The user to whom the task is assigned.",
            "title":"Assignee"
        },
        "TaskDescription":{
            "maxLength":400,
            "type":"string",
            "description":"The description of the task.",
            "title":"Description"
        },
        "TaskDueDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the task is due. ",
            "title":"Due Date"
        },
        "TaskNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier associated with event task.",
            "title":"Task"
        },
        "TaskTitle":{
            "maxLength":100,
            "type":"string",
            "description":"The title of the task.",
            "title":"Title"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top