Get a business plan resource
get
/crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}
Request
Path Parameters
-
BusinessPlanId(required): integer(int64)
The unique identifier of the business plan.
-
BusinessPlanResourceId(required): integer(int64)
The unique identifier of the business plan resource.
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 : businessPlans-BusinessPlanResource-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the access level of a team member. A list of valid values is defined in the lookup ORA_ZCA_BUS_PLAN_ACCESS_LEVEL. -
BusinessPlanId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the business plan. -
BusinessPlanNumber: string
Title:
Number
Maximum Length:64
Parent puid. -
BusinessPlanResourceId: integer
(int64)
Title:
Business Plan Resource ID
The unique identifier of the business plan resource. -
BusinessPlanResourceNumber: string
Title:
Resource Number
Maximum Length:230
The alternate key identifier for business plan resource. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DenormMgrId: integer
(int64)
Read Only:
true
The unique identifier of the manager of the business plan team member. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The E-Mail address of the business plan team member. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the business plan team member. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when 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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManagerName: string
Title:
Manager
Read Only:true
Maximum Length:360
The name of the manager of the business plan team member. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The code indicating the function of a team member. A list of valid values is defined in the lookup MemberFunctionCodesVA. -
OrganizationName: string
Title:
Organization
Read Only:true
Maximum Length:240
The organization name of the business plan team member. -
OwnerFlag: boolean
Title:
Owner Indicator
Read Only:true
Indicates if the business plan team member is the owner of the business plan. If the value is True, then the business plan team member is also the owner of the business plan. The default value is False. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the resource. -
ResourceName: string
Read Only:
true
Maximum Length:360
The name of the team member. -
ResourceNumber: string
Read Only:
true
Maximum Length:30
Alternate key corresponding to ResourceId. -
RoleName: string
Title:
Role
Read Only:true
Maximum Length:60
The name of the role of the team member.
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
- AccessLevelVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DORA_ZCA_BUS_PLAN_ACCESS_LEVEL
The list of values of the access levels of the business plan team members.
The following properties are defined on the LOV link relation:- Source Attribute: AccessLevelCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberFunctionCodesVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{MemberFunctionCode}%2CBindLookupType%3DORA_ZCA_BUS_PLAN_TEAM_FUNC
The list of values of the functions of the business plan team members.
The following properties are defined on the LOV link relation:- Source Attribute: MemberFunctionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
Examples
The following example shows how to get a business plan resource by submitting a GET request on the REST resource using cURL.
cURL Command
- curl -u <username:password> \ -X http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/businessPlans/300100091979253/child/BusinessPlanResource/300100091979256
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "BusinessPlanId": 300100091979253, "BusinessPlanResourceId": 300100091979256, "BusinessPlanResourceNumber": "CDRM_25043", "CreatedBy": "MHoope", "CreationDate": "2016-12-12T02:53:12-08:00", "LastUpdateDate": "2016-12-12T02:53:12-08:00", "LastUpdateLogin": "4373F6AF02325539E05364C0F20A8DA6", "LastUpdatedBy": "MHoope", "MemberFunctionCode": null, "ResourceId": 100010032635999, "OwnerFlag": false, "EmailAddress": "sendmail-test-discard@oracle.com", "ResourceName": "Billy ZHRS-Taylor", "FormattedPhoneNumber": null, "OrganizationName": null, "DenormMgrId": null, "RoleName": null, "ManagerName": null, ... }