Jump to

• Request
• Response
• Examples

Get an opportunity deal

get

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OpportunityDeal/{OptyDealId}

Request

Path Parameters

• OptyDealId(required): integer
  The unique identifier of the opportunity deal.
• OptyNumber(required): string
  The unique alternate identifier for the opportunity.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : opportunities-OpportunityDeal-item-response

Type: object

Show Source

• ApprovedDate: string (date)
  Title: Approved Date

  Read Only: true

  The date and time when deal was approved.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the opportunity deal record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the opportunity deal record was created.
• DealExpirationDate: string (date)
  Title: Expiration Date

  Read Only: true

  The date and time when the deal is set to expire.
• DealId: integer
  Title: Deal ID

  The unique identifier of the deal.
• DealName: string
  Title: Deal Name

  Read Only: true

  Maximum Length: 250

  The name of the opportunity deal.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  The alternate key identifier of the deal registration.
• DealSize: number
  Title: Deal Size

  Read Only: true

  The size of the deal associated with the opportunity.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the opportunity deal record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

  The session login associated with the user who last updated the opportunity deal record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OptyDealId: integer
  Title: Opportunity Deal ID

  Read Only: true

  The unique identifier of the opportunity deal.
• OptyId: integer
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.
• PartnerId: integer (int64)
  Title: Partner ID

  Read Only: true

  The unique identifier of the partner tracked in the deal.
• PartyName: string
  Title: Partner

  Read Only: true

  Maximum Length: 360

  The name of the partner.
• StatusCode: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  The code indicating the status of the opportunity deal. A list of valid values is defined in the lookup ORA_MKL_DEAL_REG_STATUS.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the opportunity deal record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the opportunity deal record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealId":{
            "title":"Deal ID",
            "type":"integer",
            "description":"The unique identifier of the deal.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the opportunity deal record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date and time when deal was approved.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the deal registration.",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The unique identifier of the partner tracked in the deal.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DealSize":{
            "title":"Deal Size",
            "type":"number",
            "description":"The size of the deal associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the opportunity deal. A list of valid values is defined in the lookup ORA_MKL_DEAL_REG_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DealExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date and time when the deal is set to expire.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DealName":{
            "title":"Deal Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the opportunity deal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyDealId":{
            "title":"Opportunity Deal ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity deal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the opportunity deal 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 session login associated with the user who last updated the opportunity deal record.",
            "nullable":true,
            "readOnly":true,
            "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

StatusCodeLOV

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_DEAL_REG_STATUS%2CBindLookupCode%3D{StatusCode}

The lookups resource is used to view standard lookup codes.

Back to Top

Examples

The following example shows how to get an opportunity deal by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_335580/child/OpportunityDeal/300100092363935

Example of Response Body

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

{
"PartyName": "Stryker Corp.",
"StatusCode": "ORA_APPROVED",
"DealName": null,
"OptyDealId": 300100092363935,
"OptyId": 300100092363928,
"DealExpirationDate": "2017-01-16",
"CreatedBy": "JLOPEZ",
"CreationDate": "2016-11-16T05:02:42-08:00",
"LastUpdateDate": "2016-11-16T05:03:04-08:00",
"LastUpdateLogin": "3F16A2DC2AF92E0FE05354C0F20A6B55",
"LastUpdatedBy": "JLOPEZ",
"PartnerId": 100000016934002,
"DealId": 300100092363896,
"DealNumber": "CDRM_47006",
"ApprovedDate": "2016-10-18",
...
}

Back to Top