Get a quote integration configuration
get
/crmRestApi/resources/11.13.18.05/salesOrderCPQIntegrationConfigurations/{OrderSetupRefId}
Request
Path Parameters
-
OrderSetupRefId(required): integer(int64)
The unique identifier of the order setup row.
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 TopResponse
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.
Root Schema : salesOrderCPQIntegrationConfigurations-item-response
Type:
Show Source
object
-
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Indicates whether the configuration is active. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time the record was created. -
DefaultFlag: boolean
Title:
Default
Maximum Length:1
The default quoting system for opportunity. -
Description: string
Title:
Description
Maximum Length:1995
An optional text description that an administrative user can add to describe a specific CPQ integration. -
DocumentName: string
Title:
Document Name
Maximum Length:255
The name of the document associated with the integration. -
EndPointUrl: string
Title:
End Point URL
The endpoint URL for the integration. -
FilterConditionForOpty: string
Maximum Length:
1000
The filter condition for the opportunity. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the last update was made. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:150
The user specified name for the target CPQ integration. -
OptInRevnSync: string
Title:
Restrict Revenue Edit
Maximum Length:1
This parameter controls revenue synchronization for the integration. -
OrderSetupRefId: integer
(int64)
The unique identifier of the order setup row.
-
Priority: integer
(int64)
Title:
Priority
The priority sequence of the CPQ endpoints. -
ProcessName: string
Title:
Process Name
Maximum Length:255
The process name defined in CPQ for integration. -
RestFrameworkVersion: string
Title:
REST Framework Version
Maximum Length:3
The version identifier for CPQ REST. -
RevnReconcileOption: string
Title:
Revenue Reconcile Option
Maximum Length:30
Indicates the level at which we are reconciling quote line information into the revenue table. -
SalesOrdersSetupDsbldRevnFields: array
Sales Order Setup Disabled Revenue Fields
Title:
Sales Order Setup Disabled Revenue Fields
The sales order setup disabled revenue fields resource is used to view the disabled revenue fields after a opportunity is quoted. The foreign key is used for identifying the relation between disabled revenue field and order setup reference identifier. -
SalesOrdersSetupRefDetails: array
Sales Order Setup Reference Details
Title:
Sales Order Setup Reference Details
The sales order setup reference details is used to view the sales order setup detail rows. -
SetupRefCode: string
Title:
Reference Code
Maximum Length:80
The unique reference code used for generating and referring the code and host respectively.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Sales Order Setup Disabled Revenue Fields
Type:
array
Title:
Sales Order Setup Disabled Revenue Fields
The sales order setup disabled revenue fields resource is used to view the disabled revenue fields after a opportunity is quoted. The foreign key is used for identifying the relation between disabled revenue field and order setup reference identifier.
Show Source
Nested Schema : Sales Order Setup Reference Details
Type:
array
Title:
Sales Order Setup Reference Details
The sales order setup reference details is used to view the sales order setup detail rows.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : salesOrderCPQIntegrationConfigurations-SalesOrdersSetupDsbldRevnFields-item-response
Type:
Show Source
object
-
Comments: string
Maximum Length:
255
The additional user comments for the disabled revenue field. -
ConflictId: integer
(int64)
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
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrdersDsbldRevnFieldId: integer
(int64)
The unique identifier of the disabled revenue field record.
-
OrderSetupRefId: integer
(int64)
The foreign key used for identifying the relation between disabled revenue field and order setup reference identifier.
-
RevnFieldName: string
Maximum Length:
255
The disabled revenue field name that is disabled once opportunity is quoted.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesOrderCPQIntegrationConfigurations-SalesOrdersSetupRefDetails-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the record was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderSetupRefDetailId: integer
(int64)
The unique identifier of the setup details row.
-
OrderSetupRefId: integer
(int64)
The identifier of the order setup row.
-
ProcessParameterName: string
Title:
Name
Maximum Length:150
The predefined parameter to be appended to hosting url used in integration. -
ProcessParameterValue: string
Title:
Value
Maximum Length:2000
The value corresponding to the process parameter name defined.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- SalesOrdersSetupDsbldRevnFields
-
Parameters:
- OrderSetupRefId:
$request.path.OrderSetupRefId
The sales order setup disabled revenue fields resource is used to view the disabled revenue fields after a opportunity is quoted. The foreign key is used for identifying the relation between disabled revenue field and order setup reference identifier. - OrderSetupRefId:
- SalesOrdersSetupRefDetails
-
Parameters:
- OrderSetupRefId:
$request.path.OrderSetupRefId
The sales order setup reference details is used to view the sales order setup detail rows. - OrderSetupRefId: