Jump to

• Request
• Response
• Examples

Get a task

get

/services/rest/connect/v1.4/tasks/{id}

Request

Path Parameters

• id(required): integer
  The unique identifier of the task.

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

• assignedToAccount: [ "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: [ "string", "null" ]
  The date and time when the task was completed.
• contact: [ "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: string
  The date and time when the task was created. This attribute is read-only.
• dueTime: [ "string", "null" ]
  The date and time when the task is due.
• fileAttachments: object tasks-fileAttachments
  The file attachment that includes additional fields used for attachments to various classes.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the task.
• inherit: object tasks-inherit
  The information about data values inherited by a task from an associated object, such as an incident or an opportunity.
• lookupName: string
  Maximum Length: 255

  The name used to look up the task.
• marketingSettings: object tasks-marketingSettings
  The marketing related information for the task.
• name: string
  Maximum Length: 240

  The name used to describe the task.
• notes: object tasks-notes
  The note text associated with the objects such as contacts and organizations.
• organization: [ "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: [ "integer", "null" ]
  Minimum Value: 0

  Maximum Value: 100

  The percentage of work completed.
• plannedCompletionTime: [ "string", "null" ]
  The date and time when the task is planned for completion.
• priority: 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: object tasks-salesSettings
  The sales related information for the task.
• serviceSettings: object tasks-serviceSettings
  The service related information for the task.
• startTime: [ "string", "null" ]
  The date and time when the task started.
• statusWithType: object tasks-statusWithType
  The status of an object with its associated status type.
• taskTemplate: 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: 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: string
  The date and time when the task was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"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.",
    "properties":{
        "assignedToAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"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."
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the task.",
            "maxLength":"255"
        },
        "percentComplete":{
            "minimum":"0",
            "type":[
                "integer",
                "null"
            ],
            "description":"The percentage of work completed.",
            "maximum":"100"
        },
        "taskType":{
            "type":[
                "object",
                "null"
            ],
            "description":"The identifier of the task type, such as incident task. This works in conjunction with the inherit options to determine which associated object to inherit the data from.",
            "$ref":"#/definitions/namedIDs-tasks-taskType"
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the task.",
            "maximum":"9223372036854776000"
        },
        "marketingSettings":{
            "type":"object",
            "description":"The settings specific to the marketing module.",
            "$ref":"#/definitions/tasks-marketingSettings"
        },
        "completedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the task was completed."
        },
        "fileAttachments":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of file attachments.",
            "$ref":"#/definitions/tasks-fileAttachments"
        },
        "priority":{
            "type":[
                "object",
                "null"
            ],
            "description":"The relative priority.",
            "$ref":"#/definitions/namedIDs-tasks-priority"
        },
        "statusWithType":{
            "type":"object",
            "description":"The current status.",
            "$ref":"#/definitions/tasks-statusWithType"
        },
        "serviceSettings":{
            "type":"object",
            "description":"The settings specific to the service module.",
            "$ref":"#/definitions/tasks-serviceSettings"
        },
        "dueTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the task is due."
        },
        "taskTemplate":{
            "type":"object",
            "description":"The template for the business process.",
            "$ref":"#/definitions/namedIDs-tasks-taskTemplate"
        },
        "plannedCompletionTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the task is planned for completion."
        },
        "startTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the task started."
        },
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the task was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The name used to describe the task.",
            "maxLength":"240"
        },
        "notes":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of discussion threads.",
            "$ref":"#/definitions/tasks-notes"
        },
        "inherit":{
            "type":"object",
            "description":"The group of flags that determine which data is inherited from the associated objects.",
            "$ref":"#/definitions/tasks-inherit"
        },
        "contact":{
            "type":[
                "object",
                "null"
            ],
            "description":"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":{
            "type":"string",
            "description":"The date and time when the task was created. This attribute is read-only."
        },
        "organization":{
            "type":[
                "object",
                "null"
            ],
            "description":"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."
        },
        "salesSettings":{
            "type":"object",
            "description":"The settings specific to the sales module.",
            "$ref":"#/definitions/tasks-salesSettings"
        }
    }
}

Nested Schema : tasks-fileAttachments

Type: object

The file attachment that includes additional fields used for attachments to various classes.

Show Source

• contentType: 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: string
  The date and time when the file was associated with the object. This attribute is read-only.
• data: 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: string
  Maximum Length: 1333

  The description for the contents of the file attachment.
• fileName: string
  Maximum Length: 100

  Pattern: ^[^ \/:*?"<>|]*$

  The name of the file when saving it to the disk.
• formData: string
  The HTML form which is used to upload file attachments.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the file attachment.
• name: string
  Maximum Length: 40

  Pattern: ^[^ ]*$

  The short display name of the file attachment.
• size: integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The size of the file in bytes. This attribute is read-only.
• updatedTime: [ "string", "null" ]
  The date and time when the file attachment was last updated. This attribute is read-only.
• uRL: string
  Maximum Length: 1333

  The URL to access this file.

{
    "type":"object",
    "description":"The file attachment that includes additional fields used for attachments to various classes.",
    "properties":{
        "updatedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the file attachment was last updated. This attribute is read-only."
        },
        "contentType":{
            "pattern":"^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$",
            "type":"string",
            "description":"The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.",
            "maxLength":"128"
        },
        "name":{
            "pattern":"^[^\t\n]*$",
            "type":"string",
            "description":"The short display name of the file attachment.",
            "maxLength":"40"
        },
        "uRL":{
            "type":"string",
            "description":"The URL to access this file.",
            "maxLength":"1333"
        },
        "formData":{
            "type":"string",
            "description":"The HTML form which is used to upload file attachments."
        },
        "description":{
            "type":"string",
            "description":"The description for the contents of the file attachment.",
            "maxLength":"1333"
        },
        "fileName":{
            "pattern":"^[^\t\n\\/:*?\"<>|]*$",
            "type":"string",
            "description":"The name of the file when saving it to the disk.",
            "maxLength":"100"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the file was associated with the object. This attribute is read-only."
        },
        "data":{
            "type":"string",
            "description":"The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field."
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the file attachment.",
            "maximum":"9223372036854776000"
        },
        "size":{
            "minimum":"1",
            "type":"integer",
            "description":"The size of the file in bytes. This attribute is read-only.",
            "maximum":"2147483647"
        }
    }
}

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: boolean
  Indicates whether the task inherits contact value from the associated object. The default value is false.
• inheritOrganization: boolean
  Indicates whether the task inherits organization value from the associated object. The default value is false.
• inheritStaffAssignment: boolean
  Indicates whether the task inherits account value from the associated object. The default value is false.

{
    "type":"object",
    "description":"The information about data values inherited by a task from an associated object, such as an incident or an opportunity.",
    "properties":{
        "inheritContact":{
            "type":"boolean",
            "description":"Indicates whether the task inherits contact value from the associated object. The default value is false."
        },
        "inheritStaffAssignment":{
            "type":"boolean",
            "description":"Indicates whether the task inherits account value from the associated object. The default value is false."
        },
        "inheritOrganization":{
            "type":"boolean",
            "description":"Indicates whether the task inherits organization 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: [ "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: 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: 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: 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.

{
    "type":"object",
    "description":"The marketing related information for the task.",
    "properties":{
        "mailing":{
            "type":[
                "object",
                "null"
            ],
            "description":"The associated mailing.",
            "$ref":"#/definitions/namedIDs-tasks-marketingSettings-mailing"
        },
        "document":{
            "type":[
                "object",
                "null"
            ],
            "description":"The associated marketing document.",
            "$ref":"#/definitions/namedIDs-tasks-marketingSettings-document"
        },
        "survey":{
            "type":[
                "object",
                "null"
            ],
            "description":"The associated survey.",
            "$ref":"#/definitions/namedIDs-tasks-marketingSettings-survey"
        },
        "campaign":{
            "type":[
                "object",
                "null"
            ],
            "description":"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."
        }
    }
}

Nested Schema : tasks-notes

Type: object

The note text associated with the objects such as contacts and organizations.

Show Source

• channel: 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: [ "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: string
  The date and time when the note was created. This attribute is read-only.
• id: integer
  Minimum Value: 1

  Maximum Value: 9223372036854776000

  The unique identifier of the note.
• text: string
  Maximum Length: 349525

  The text content in the note.
• updatedByAccount: [ "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: string
  The date and time when the note was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The note text associated with the objects such as contacts and organizations.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the note was last updated. This attribute is read-only."
        },
        "updatedByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"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."
        },
        "text":{
            "type":"string",
            "description":"The text content in the note.",
            "maxLength":"349525"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the note was created. This attribute is read-only."
        },
        "createdByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"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."
        },
        "id":{
            "minimum":"1",
            "type":"integer",
            "description":"The unique identifier of the note.",
            "maximum":"9223372036854776000"
        },
        "channel":{
            "type":[
                "object",
                "null"
            ],
            "description":"The channel through which the note was created.",
            "$ref":"#/definitions/namedIDs-tasks-notes-channel"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Nested Schema : tasks-salesSettings

Type: object

The sales related information for the task.

Show Source

• opportunity: [ "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.

{
    "type":"object",
    "description":"The sales related information for the task.",
    "properties":{
        "opportunity":{
            "type":[
                "object",
                "null"
            ],
            "description":"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: [ "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: [ "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.

{
    "type":"object",
    "description":"The service related information for the task.",
    "properties":{
        "answer":{
            "type":[
                "object",
                "null"
            ],
            "description":"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":{
            "type":[
                "object",
                "null"
            ],
            "description":"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: 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: 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.

{
    "type":"object",
    "description":"The status of an object with its associated status type.",
    "properties":{
        "status":{
            "type":"object",
            "description":"The current status.",
            "$ref":"#/definitions/namedIDs-tasks-statusWithType-status"
        },
        "statusType":{
            "type":"object",
            "description":"The associated status type. This attribute is read-only.",
            "$ref":"#/definitions/namedIDs-tasks-statusWithType-statusType"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

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: integer
  Minimum Value: 0

  ID value
• lookupName: string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"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.",
    "properties":{
        "id":{
            "minimum":"0",
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":"255"
        }
    }
}

Back to Top

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"
    }
  ]
}

Back to Top