Get an interview
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Interviews/{opportunities_Interviews_Id}
Request
Path Parameters
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
-
opportunities_Interviews_Id(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 : opportunities-Interviews-item-response
Type:
Show Source
object
-
AttachmentId: integer
(int64)
Title:
Attachment ID
The identifier for attachment of interview summary. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the interview record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the interview record was created. -
InterviewData: string
(byte)
Title:
Interview Data
The submitted interview data containing questionnaires and responses. -
InterviewDataLang: string
Title:
Interview Data Language
Maximum Length:30
The language in which interview has been submitted. -
InterviewDraft: string
(byte)
Title:
Interview Draft
The draft interview data. This allows a user to continue from the saved draft. -
InterviewId: integer
(int64)
Title:
Interview ID
The unique identifier of interview record. -
InterviewName: string
Title:
Interview Name
Maximum Length:100
The name of the interview. -
InterviewNumber: string
Title:
Interview Number
Maximum Length:30
The public unique identifier of the interview record. -
InterviewStatus: string
Title:
Interview Status
Maximum Length:30
Specifies the status of the interview -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date and time when the interview record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the interview record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Indicates the session login associated to the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
Read Only:true
Specifies how many times the row has been updated. -
OwnerResourceId: integer
(int64)
Title:
Owner Resource ID
The unique identifier of the user who created the record. -
OwnerResourceNumber: string
Title:
Owner Resource Number
Read Only:true
Maximum Length:30
The public unique identifier of the user who created the record. -
OwnerResourcePartyName: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the user who created the interview record. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:30
The name of the top level object associated with the interview. -
SourceObjectId: integer
(int64)
Title:
Source Object ID
The unique identifier of top level object associated with the interview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.
Links
- InterviewStatusLookupPVO
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_INTERVIEW_STATUS
The list of valid statuses for the interview record. - finder: