Activities Objectives

Subcategories:

The activity captures the objectives associated to the activity.

Resource Plural Label

Activity Objectives

Resource Name

ActivityObjectives

Get all Activities Objectives

Request: GET

URI: /crmRestApi/resources/<version>/activities/{ActivityNumber}/child/ActivityObjectives

Request Path Parameters

There are no request path parameters for this task.

Request Query Parameters

There are no request query parameters for this task.

Request Body

There are no elements in the request body for this task.

Response Body

This table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Create an Activities Objective

Request: POST

URI: /crmRestApi/resources/<version>/activities/{ActivityNumber}/child/ActivityObjectives

Request Path Parameters

There are no request path parameters for this task.

Request Body

This table summarizes the supported request body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Response Body

This table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Get an Activities Objective

Request: GET

URI: /crmRestApi/resources/<version>/activities/{ActivityNumber}/child/ActivityObjectives/{ObjectiveId}

Request Path Parameters

There are no request path parameters for this task.

Request Body

There are no elements in the request body for this task.

Response Body

This table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Update an Activities Objective

Request: PATCH

URI: /crmRestApi/resources/<version>/activities/{ActivityNumber}/child/ActivityObjectives/{ObjectiveId}

Request Path Parameters

There are no request path parameters for this task.

Request Body

This table summarizes the request body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Response Body

This table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Delete an Activities Objective

Request: DELETE

URI: /crmRestApi/resources/<version>/activities/{ActivityNumber}/child/ActivityObjectives/{ObjectiveId}

Request Path Parameters

There are no request path parameters for this task.

Request Body

There are no elements in the request body for this task.

Response Body

There are no elements in the response body for this task.

Replace an Activities Objective

Request: PUT

URI: /crmRestApi/resources/<version>/activities/{ActivityNumber}/child/ActivityObjectives/{ObjectiveId}

Request Path Parameters

There are no request path parameters for this task.

Request Body

This table summarizes the supported request body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

Response Body

This table summarizes the supported response body content types:

Media Type

application/vnd.oracle.adf.resourcecollection+json

List of Values

This table lists all the list of values of the resource.

LOV Name Source Attribute in LOV Target Attribute in Resource

RatedCurrenciesVA

CurrencyCode

CurrencyCode

LookupCode

ObjectiveCode

ObjectiveLookup

LookupCode

ObjectiveCode

Resource Attributes

This table lists all the attributes of the resource.

Attribute Name Attribute Type Description

ActivityId

integer

The unique identifier of the parent activity.

ObjectiveCode

string

The code indicating the objectives of an activity. A list of valid values is defined in the lookup ORA_ZMM_ACTIVITY_OBJECTIVE.

Properties:

The maximum length is 30.

UI Label:

Objective

ObjectiveFreefmtText

string

The text area to describe the objective of the activity.

Properties:

The maximum length is 80.

UI Label:

Objective Free-Form Text

ObjectiveId

integer

The unique identifier of the objective.

CreationDate

string

The date and time when the activity objective was created.

CreatedBy

string

The user who created the activity objective.

LastUpdateDate

string

The date and time when the activity objective was last updated.

LastUpdatedBy

string

The user who last updated the activity objective.

LastUpdateLogin

string

The login details of the user who last updated the activity objective.

ObjectVersionNumber

integer

The version number of the object associated with the activity assignee.

ConflictId

integer

The unique identifier for the conflict in the activity objectives.

CompletedFlag

boolean

Indicates if the activity objective is completed. If True, the activity is completed.

Properties:

The maximum length is 1.

UI Label:

Complete

CorpCurrencyCode

string

The corporate currency code associated with the activity contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.

Properties:

The maximum length is 15.

CurcyConvRateType

string

The currency conversion rate type associated with the activity contact. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.

Properties:

The maximum length is 30.

CurrencyCode

string

The currency code. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.

Properties:

The maximum length is 15.

Activity

object

The activity that uses the objective.

AttributeCategory

string

Standard field

ActivityNumber

string

Standard field

RecurSeriesId

integer

Standard field

ActivityObjective

string

Standard field

Properties:

The maximum length is 255.

ActyActivityNumber

string

Standard field

Properties:

The maximum length is 64.

UI Label:

Activity Number