Get a task
get
/services/rest/connect/v1.4/tasks/{id}
Request
Path Parameters
-
id: integer
The unique identifier of the task.
Response
Default Response
Root Schema : tasks
Type:
object
The information about an action or an activity scheduled to be completed within a specified time. Tasks can be standalone or they can be associated with answers, campaigns, contacts, documents, incidents, mailings, opportunities, organizations, surveys, and stages in a sales strategy.
Show Source
-
assignedToAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
completedTime(optional):
[
"string",
"null"
]
The date and time when the task was completed.
-
contact(optional):
[
"object",
"null"
]
The customers or end users of Oracle B2C Service site. A contact contains basic information such as a customer's name, email address, and phone number. It also contains information about customer service issues, opportunities, and marketing mailings subscription status. It is the reference to a resource in 'contacts' collection. Only ID or lookupName can be provided to specify the resource.
-
createdTime(optional):
string
The date and time when the task was created. This attribute is read-only.
-
dueTime(optional):
[
"string",
"null"
]
The date and time when the task is due.
-
fileAttachments(optional):
object tasks-fileAttachments
The file attachment that includes additional fields used for attachments to various classes.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the task. -
inherit(optional):
object tasks-inherit
The information about data values inherited by a task from an associated object, such as an incident or an opportunity.
-
lookupName(optional):
string
Maximum Length:
255
The name used to look up the task. -
marketingSettings(optional):
object tasks-marketingSettings
The marketing related information for the task.
-
name(optional):
string
Maximum Length:
240
The name used to describe the task. -
notes(optional):
object tasks-notes
The note text associated with the objects such as contacts and organizations.
-
organization(optional):
[
"object",
"null"
]
The company, business unit of a large company, or government agency that has an organization record in the Oracle B2C Service knowledge base. It is the reference to a resource in 'organizations' collection. Only ID or lookupName can be provided to specify the resource.
-
percentComplete(optional):
[
"integer",
"null"
]
Minimum Value:
0
Maximum Value:100
The percentage of work completed. -
plannedCompletionTime(optional):
[
"string",
"null"
]
The date and time when the task is planned for completion.
-
priority(optional):
object namedIDs-tasks-priority
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
salesSettings(optional):
object tasks-salesSettings
The sales related information for the task.
-
serviceSettings(optional):
object tasks-serviceSettings
The service related information for the task.
-
startTime(optional):
[
"string",
"null"
]
The date and time when the task started.
-
statusWithType(optional):
object tasks-statusWithType
The status of an object with its associated status type.
-
taskTemplate(optional):
object namedIDs-tasks-taskTemplate
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
taskType(optional):
object namedIDs-tasks-taskType
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
updatedTime(optional):
string
The date and time when the task was last updated. This attribute is read-only.
Nested Schema : tasks-fileAttachments
Type:
object
The file attachment that includes additional fields used for attachments to various classes.
Show Source
-
contentType(optional):
string
Maximum Length:
128
Pattern:^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$
The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on. -
createdTime(optional):
string
The date and time when the file was associated with the object. This attribute is read-only.
-
data(optional):
string
The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
-
description(optional):
string
Maximum Length:
1333
The description for the contents of the file attachment. -
fileName(optional):
string
Maximum Length:
100
Pattern:^[^ \/:*?"<>|]*$
The name of the file when saving it to the disk. -
formData(optional):
string
The HTML form which is used to upload file attachments.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the file attachment. -
name(optional):
string
Maximum Length:
40
Pattern:^[^ ]*$
The short display name of the file attachment. -
size(optional):
integer
Minimum Value:
1
Maximum Value:2147483647
The size of the file in bytes. This attribute is read-only. -
updatedTime(optional):
[
"string",
"null"
]
The date and time when the file attachment was last updated. This attribute is read-only.
-
uRL(optional):
string
Maximum Length:
1333
The URL to access this file.
Nested Schema : tasks-inherit
Type:
object
The information about data values inherited by a task from an associated object, such as an incident or an opportunity.
Show Source
-
inheritContact(optional):
boolean
Indicates whether the task inherits contact value from the associated object. The default value is false.
-
inheritOrganization(optional):
boolean
Indicates whether the task inherits organization value from the associated object. The default value is false.
-
inheritStaffAssignment(optional):
boolean
Indicates whether the task inherits account value from the associated object. The default value is false.
Nested Schema : tasks-marketingSettings
Type:
object
The marketing related information for the task.
Show Source
-
campaign(optional):
[
"object",
"null"
]
The information on email marketing campaigns created in Oracle B2C Service Outreach Cloud Service. It is the reference to a resource in 'campaigns' collection. Only ID or lookupName can be provided to specify the resource.
-
document(optional):
object namedIDs-tasks-marketingSettings-document
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
mailing(optional):
object namedIDs-tasks-marketingSettings-mailing
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
survey(optional):
object namedIDs-tasks-marketingSettings-survey
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : tasks-notes
Type:
object
The note text associated with the objects such as contacts and organizations.
Show Source
-
channel(optional):
object namedIDs-tasks-notes-channel
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
createdByAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
createdTime(optional):
string
The date and time when the note was created. This attribute is read-only.
-
id(optional):
integer
Minimum Value:
1
Maximum Value:9.223372036854776E18
The unique identifier of the note. -
text(optional):
string
Maximum Length:
349525
The text content in the note. -
updatedByAccount(optional):
[
"object",
"null"
]
The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
-
updatedTime(optional):
string
The date and time when the note was last updated. This attribute is read-only.
Nested Schema : namedIDs-tasks-priority
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : tasks-salesSettings
Type:
object
The sales related information for the task.
Show Source
-
opportunity(optional):
[
"object",
"null"
]
The information about a specific sale or a pending deal with a contact or an organization that is tracked and maintained in the Oracle B2C Service knowledge base. It is the reference to a resource in 'opportunities' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : tasks-serviceSettings
Type:
object
The service related information for the task.
Show Source
-
answer(optional):
[
"object",
"null"
]
The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resource.
-
incident(optional):
[
"object",
"null"
]
The question or the request for help submitted by a customer through the Ask a Question page, email, a chat session, site or answer feedback, or from an external source using the API. Incidents can also be added by agents when they work with customers by phone, fax, or mail. It is the reference to a resource in 'incidents' collection. Only ID or lookupName can be provided to specify the resource.
Nested Schema : tasks-statusWithType
Type:
object
The status of an object with its associated status type.
Show Source
-
status(optional):
object namedIDs-tasks-statusWithType-status
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
-
statusType(optional):
object namedIDs-tasks-statusWithType-statusType
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Nested Schema : namedIDs-tasks-taskTemplate
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-tasks-taskType
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-tasks-marketingSettings-document
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-tasks-marketingSettings-mailing
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-tasks-marketingSettings-survey
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-tasks-notes-channel
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-tasks-statusWithType-status
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Nested Schema : namedIDs-tasks-statusWithType-statusType
Type:
object
An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
Show Source
-
id(optional):
integer
Minimum Value:
0
ID value -
lookupName(optional):
string
Maximum Length:
255
Name used to lookup this object
Examples
Use GET with the following syntax to retrieve data for a task:
https://your_site_interface/services/rest/connect/version/tasks/task_id
Request URI example
https://mysite.example.com/services/rest/connect/v1.4/tasks/9
Response body example
{
"id": 9,
"lookupName": "Schedule internal trial",
"createdTime": "2015-12-01T18:39:38.000Z",
"updatedTime": "2015-12-01T18:39:38.000Z",
"assignedToAccount": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/3"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/3"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
"mediaType": "application/schema+json"
}
]
},
"completedTime": "2015-12-01T18:36:54.000Z",
"contact": null,
"customFields": {
"c": {}
},
"dueTime": "2015-12-01T18:36:20.000Z",
"fileAttachments": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/tasks/9/fileAttachments"
}
]
},
"inherit": {
"inheritContact": false,
"inheritOrganization": false,
"inheritStaffAssignment": false
},
"marketingSettings": {
"campaign": {
"id": 1,
"lookupName": "100 Free Minutes"
},
"document": null,
"mailing": null,
"survey": null
},
"name": "Schedule internal trial",
"notes": {
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/tasks/9/notes"
}
]
},
"organization": null,
"percentComplete": 100,
"plannedCompletionTime": null,
"priority": null,
"salesSettings": {
"opportunity": null
},
"serviceSettings": {
"answer": null,
"incident": null
},
"startTime": null,
"statusWithType": {
"status": {
"id": 18,
"lookupName": "Completed"
},
"statusType": {
"id": 13,
"lookupName": "Complete"
}
},
"taskTemplate": null,
"taskType": {
"id": 163,
"lookupName": "Campaigns"
},
"links": [
{
"rel": "self",
"href": "https://mysite.example.com/services/rest/connect/v1.4/tasks/9"
},
{
"rel": "canonical",
"href": "https://mysite.example.com/services/rest/connect/v1.4/tasks/9"
},
{
"rel": "describedby",
"href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/tasks",
"mediaType": "application/schema+json"
}
]
}