Jump to

• Request
• Response

Update an objective initiative

patch

/crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Goals/{GoalNumber}/child/SalesObjectives/{ObjectiveId}/child/Initiatives/{InitiativeId}

Request

Path Parameters

• BusinessPlanId(required): integer(int64)
  The unique identifier of the business plan.
• GoalNumber(required): string
  The identifier for the goal number.
• InitiativeId(required): integer(int64)
  The unique identifier for initiative.
• ObjectiveId(required): integer(int64)
  The unique identifier of the objective.

Header Parameters

• Metadata-Context: string
  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: string
  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

• OptyNumber: string
  Title: Opportunity Number

  Unique identifier for opportunity.

{
    "type":"object",
    "properties":{
        "OptyNumber":{
            "title":"Opportunity Number",
            "type":"string",
            "description":"Unique identifier for opportunity.",
            "nullable":false
        }
    }
}

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 : businessPlans-Goals-SalesObjectives-Initiatives-item-response

Type: object

Show Source

• BusinessPlanId: integer (int64)
  Title: Business Plan ID

  The identification key for business plan.
• BusinessPlanNumber: string
  Title: Business Plan Number

  Read Only: true

  Maximum Length: 64

  The number of the business plan for which an initiative was created.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Lists who created the row of data.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CustomerId: integer (int64)
  Title: Customer ID

  Read Only: true

  The customer identifier that is associated with the business plan.
• GoalId: integer (int64)
  Title: Goal ID

  The system generated identifier for the business plan goals.
• InitiativeId: integer (int64)
  Title: Initiative ID

  The unique identifier for initiative.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• LeadId: integer (int64)
  Title: Lead ID

  The unique identifier for the lead associated with the business plan.
• LeadNumber: string
  Title: Lead Number

  Unique identifier for lead.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectiveId: integer (int64)
  Title: Objective ID

  The unique identifier for objective.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier for the opportunity associated with the business plan.
• OptyNumber: string
  Title: Opportunity Number

  Unique identifier for opportunity.

{
    "type":"object",
    "properties":{
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The identification key for business plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "maxLength":64,
            "type":"string",
            "description":"The number of the business plan for which an initiative was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Lists who created the row of data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"The customer identifier that is associated with the business plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"The system generated identifier for the business plan goals.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InitiativeId":{
            "title":"Initiative ID",
            "type":"integer",
            "description":"The unique identifier for initiative.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier for the lead associated with the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "type":"string",
            "description":"Unique identifier for lead.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier for objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier for the opportunity associated with the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "type":"string",
            "description":"Unique identifier for opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Back to Top