Get a fund request resource
get
/crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/FundRequestResource/{FundRequestResourceId}
Request
Path Parameters
-
FundRequestCode(required): string
The code indicating the user-defined, unique label for the MDF request.
-
FundRequestResourceId(required): integer(int64)
The unique identifier of the resource in the MDF request team. This is a system-generated value.
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 : mdfRequests-FundRequestResource-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the level of access of the resource in the MDF request team. A list of valid values is defined in the lookup AccessLevelCode. The valid values are View, Edit, or Full. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource in the MDF request team. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the resource was created in the MDF request team. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The e-mail address of the MDF Request team member associated with the MDF Request. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the MDF Request team member associated with the MDF Request. -
FundRequestCode: string
Title:
Code
Maximum Length:100
The public unique identifier for the marketing fund request. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the MDF request associated with the resource. This is a system-generated value. -
FundRequestResourceId: integer
(int64)
Title:
MDF Request Resource ID
The unique identifier of the resource in the MDF request team. This is a system-generated value. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the MDF request team member record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the MDF request team member record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the MDF request team member record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The code indicating the function of the MDF Request team member. A list of valid values is defined in the lookup MemberFunctionCode. The valid values are Channel Account Manager, Channel Sales Manager, Marketing Specialist, Support Specialist, Sales Representative, Sales Manager, or MDF Request Processor. -
OwnerFlag: boolean
Title:
Owner
Read Only:true
Indicates whether the MDF Request team member is the owner of the MDF Request. The default value is true. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the resource. -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the MDF Request team member associated with the MDF Request. -
ResourcePartyNumber: string
Title:
Resource Party Number
Read Only:true
Maximum Length:30
The public unique identifier for the resource. -
ResourceUsername: string
Title:
Resource User Name
Read Only:true
The login username of the MDF Request team member associated with the MDF Request. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date when the user last updated the record.
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
- AccessLevelCodesVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDF_ACCESS_LVL%2CBindLookupCode%3D{AccessLevelCode}
The lookups resource is used to view standard lookup codes. - finder:
- MemberFunctionCodesVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{MemberFunctionCode}%2CBindLookupType%3DORA_MKT_MDFREQUEST_FUNC
The lookups resource is used to view standard lookup codes. - finder:
- ResourceVOVA
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesA front office person. For example, sales persons or partner members can be tagged as resources.