1. REST API for Oracle B2C Service
  2. Tasks
  3. Tasks

Create a task

post

/services/rest/connect/v1.4/tasks

Request

Body ()
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.
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
Nested Schema : tasks-fileAttachments
Type: object
The file attachment that includes additional fields used for attachments to various classes.
Show Source
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
Nested Schema : tasks-marketingSettings
Type: object
The marketing related information for the task.
Show Source
Nested Schema : tasks-notes
Type: object
The note text associated with the objects such as contacts and organizations.
Show Source
  • 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.
  • 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.
  • The date and time when the note was created. This attribute is read-only.
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    The unique identifier of the note.
  • Maximum Length: 349525
    The text content in the note.
  • 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.
  • 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
Nested Schema : tasks-salesSettings
Type: object
The sales related information for the task.
Show Source
  • 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
  • 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.
  • 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
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
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
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
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
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
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
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
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
Back to Top

Response

Default Response

Body ()
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
Nested Schema : tasks-fileAttachments
Type: object
The file attachment that includes additional fields used for attachments to various classes.
Show Source
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
Nested Schema : tasks-marketingSettings
Type: object
The marketing related information for the task.
Show Source
Nested Schema : tasks-notes
Type: object
The note text associated with the objects such as contacts and organizations.
Show Source
  • 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.
  • 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.
  • The date and time when the note was created. This attribute is read-only.
  • Minimum Value: 1
    Maximum Value: 9.223372036854776E18
    The unique identifier of the note.
  • Maximum Length: 349525
    The text content in the note.
  • 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.
  • 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
Nested Schema : tasks-salesSettings
Type: object
The sales related information for the task.
Show Source
  • 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
  • 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.
  • 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
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
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
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
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
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
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
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
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
Back to Top

Examples

Use POST with the following syntax to create a new task object:

https://your_site_interface/services/rest/connect/version/tasks

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/tasks

Request body example

{
"name": "Return customer call",
"contact":
    {
     "id": 83
    }
}

Note:

The name field is required for tasks.

Response body example

{
  "id": 12,
  "lookupName": "Return customer call",
  "createdTime": "2016-03-17T14:00:56.000Z",
  "updatedTime": "2016-03-17T14:00:56.000Z",
  "assignedToAccount": null,
  "completedTime": null,
  "contact": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83"
      },
      {
        "rel": "canonical",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/contacts/83"
      },
      {
        "rel": "describedby",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/contacts",
        "mediaType": "application/schema+json"
      }
    ]
  },
  "customFields": {
    "c": {}
  },
  "dueTime": null,
  "fileAttachments": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/tasks/12/fileAttachments"
      }
    ]
  },
  "inherit": {
    "inheritContact": false,
    "inheritOrganization": false,
    "inheritStaffAssignment": false
  },
  "marketingSettings": {
    "campaign": null,
    "document": null,
    "mailing": null,
    "survey": null
  },
  "name": "Return customer call",
  "notes": {
    "links": [
      {
        "rel": "self",
        "href": "https://mysite.example.com/services/rest/connect/v1.4/tasks/12/notes"
      }
    ]
  },
  "organization": null,
  "percentComplete": null,
  "plannedCompletionTime": null,
  "priority": null,
  "salesSettings": {
    "opportunity": null
  },
  "serviceSettings": {
    "answer": null,
    "incident": null
  },
  "startTime": null,
  "statusWithType": {
    "status": {
      "id": 16,
      "lookupName": "Not Started"
    },
    "statusType": {
      "id": 14,
      "lookupName": "Not Complete"
    }
  },
  "taskTemplate": null,
  "taskType": null,
  "links": [
    {
      "rel": "self",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/tasks/12"
    },
    {
      "rel": "canonical",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/tasks/12"
    },
    {
      "rel": "describedby",
      "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/tasks",
      "mediaType": "application/schema+json"
    }
  ]
}
Back to Top