Jump to

• Request
• Response
• Examples

Update an activity objective

patch

/crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityObjectives/{ObjectiveId}

Request

Path Parameters

• ActivityNumber(required): string
  The unique number of the activity. The number can also be generated from an external source.
• ObjectiveId(required): integer(int64)
  The unique identifier of the objective.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActivityId: integer (int64)
  Title: Activity ID

  The unique identifier of the parent activity.
• ActivityNumber: string
  Maximum Length: 64

  The unique number of the activity. The number can also be generated from an external source.
• ActivityObjective: string
  Maximum Length: 255

  The objective for the activity.
• AttributeCategory: string
  Maximum Length: 30

  The attribute category associated with the activity.
• CompletedFlag: boolean
  Title: Complete

  Maximum Length: 1

  Indicates if the activity objective is completed. If True, the activity is completed.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier for the conflict in the activity objectives.
• CorpCurrencyCode: string
  Maximum Length: 15

  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.
• CurcyConvRateType: string
  Maximum Length: 30

  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.
• CurrencyCode: string
  Maximum Length: 15

  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.
• ObjectiveCode: string
  Title: Objective

  Maximum Length: 30

  The code indicating the objectives of an activity. A list of valid values is defined in the lookup ORA_ZMM_ACTIVITY_OBJECTIVE.
• ObjectiveFreefmtText: string
  Title: Objective Text

  Maximum Length: 80

  The text area to describe the objective of the activity.
• RecurSeriesId: integer (int64)
  The unique identifier for the series that links instances of a series together.

{
    "type":"object",
    "properties":{
        "CompletedFlag":{
            "title":"Complete",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the activity objective is completed. If True, the activity is completed.",
            "nullable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the parent activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributeCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The attribute category associated with the activity.",
            "nullable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ObjectiveFreefmtText":{
            "title":"Objective Text",
            "maxLength":"80",
            "type":"string",
            "description":"The text area to describe the objective of the activity.",
            "nullable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier for the conflict in the activity objectives.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            }
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectiveCode":{
            "title":"Objective",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the objectives of an activity. A list of valid values is defined in the lookup ORA_ZMM_ACTIVITY_OBJECTIVE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ActivityNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The unique number of the activity. The number can also be generated from an external source.",
            "nullable":true
        },
        "ActivityObjective":{
            "maxLength":"255",
            "type":"string",
            "description":"The objective for the activity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectiveCode",
                    "ObjectiveFreefmtText"
                ]
            }
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "RecurSeriesId":{
            "type":"integer",
            "description":"The unique identifier for the series that links instances of a series together.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : activities-ActivityObjectives-item-response

Type: object

Show Source

• ActivityId: integer (int64)
  Title: Activity ID

  The unique identifier of the parent activity.
• ActivityNumber: string
  Maximum Length: 64

  The unique number of the activity. The number can also be generated from an external source.
• ActivityObjective: string
  Maximum Length: 255

  The objective for the activity.
• ActyActivityNumber: string
  Title: Activity Number

  Maximum Length: 64

  The unique number of the activity. The number can also be generated from an external source.
• AttributeCategory: string
  Maximum Length: 30

  The attribute category associated with the activity.
• CompletedFlag: boolean
  Title: Complete

  Maximum Length: 1

  Indicates if the activity objective is completed. If True, the activity is completed.
• ConflictId: integer (int64)
  Default Value: 0

  The unique identifier for the conflict in the activity objectives.
• CorpCurrencyCode: string
  Maximum Length: 15

  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.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the activity objective.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the activity objective was created.
• CurcyConvRateType: string
  Maximum Length: 30

  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.
• CurrencyCode: string
  Maximum Length: 15

  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.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the activity objective was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the activity objective.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the activity objective.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectiveCode: string
  Title: Objective

  Maximum Length: 30

  The code indicating the objectives of an activity. A list of valid values is defined in the lookup ORA_ZMM_ACTIVITY_OBJECTIVE.
• ObjectiveFreefmtText: string
  Title: Objective Text

  Maximum Length: 80

  The text area to describe the objective of the activity.
• ObjectiveId: integer (int64)
  Title: Objective ID

  The unique identifier of the objective.
• RecurSeriesId: integer (int64)
  The unique identifier for the series that links instances of a series together.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the activity objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletedFlag":{
            "title":"Complete",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the activity objective is completed. If True, the activity is completed.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the activity objective was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the activity objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier of the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the parent activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AttributeCategory":{
            "maxLength":"30",
            "type":"string",
            "description":"The attribute category associated with the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ActyActivityNumber":{
            "title":"Activity Number",
            "maxLength":"64",
            "type":"string",
            "description":"The unique number of the activity. The number can also be generated from an external source.",
            "nullable":false,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectiveFreefmtText":{
            "title":"Objective Text",
            "maxLength":"80",
            "type":"string",
            "description":"The text area to describe the objective of the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"The unique identifier for the conflict in the activity objectives.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectiveCode":{
            "title":"Objective",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the objectives of an activity. A list of valid values is defined in the lookup ORA_ZMM_ACTIVITY_OBJECTIVE.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ActivityNumber":{
            "maxLength":"64",
            "type":"string",
            "description":"The unique number of the activity. The number can also be generated from an external source.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActivityObjective":{
            "maxLength":"255",
            "type":"string",
            "description":"The objective for the activity.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ObjectiveCode",
                    "ObjectiveFreefmtText"
                ]
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the activity objective was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the activity objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurSeriesId":{
            "type":"integer",
            "description":"The unique identifier for the series that links instances of a series together.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

ObjectiveLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeIsEnabledFinder%3BBindLookupType%3DORA_ZMM_ACTIVITY_OBJECTIVE

The list of values indicating the objective of the activity.

The following properties are defined on the LOV link relation:

• Source Attribute: ObjectiveCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top

Examples

The following example shows how to update an activity objective by submitting a PATCH request on the REST resource using cURL.

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167267/child/ActivityObjectives/300100091331231

Example of Request Body

The following shows an example of the request body.

{ 
                          "ObjectiveCode":"DEMO_PRODUCT", 
                           "CompletedFlag": false,
                            "ObjectiveFreefmtText":"NEW_OBJ1235", 
                           "CompletedFlag": false 
                     
 }

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"ActivityId": 300100091331227
"ObjectiveCode": "DEMO_PRODUCT"
"ObjectiveFreefmtText": "NEW_OBJ1235"
"ObjectiveId": 300100091331231
"AttributeCategory": null
"CreationDate": "2016-08-24T00:02:57-07:00"
"CreatedBy": "SALES_ADMIN"
"LastUpdateDate": "2016-08-24T02:20:01-07:00"
"LastUpdatedBy": "SALES_ADMIN"
"LastUpdateLogin": "3ACBFC03100C5FB5E053780CF10AE876"
"ObjectVersionNumber": 4
"ConflictId": 0
"CompletedFlag": false
"ActivityNumber": null
"RecurSeriesId": null
"ObjectiveCompletedFlag": "false"
"CorpCurrencyCode": "EUR"
"CurcyConvRateType": "Corporate"
"CurrencyCode": "EUR"
-
}

Back to Top