Get a reference set enabled lookup
get
/crmRestApi/resources/11.13.18.05/serviceBusinessUnits/{BUOrgId}/child/fndSetEnabledLookups/{fndSetEnabledLookupsUniqID}
Request
Path Parameters
-
BUOrgId(required): integer(int64)
The unique identifier of the business unit.
-
fndSetEnabledLookupsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- LookupType, LookupCode and SetId ---for the Business Unit Lookups resource and used to uniquely identify an instance of Business Unit Lookups. The client should not generate the hash key value. Instead, the client should query on the Business Unit Lookups collection resource with a filter on the primary key values in order to navigate to a specific instance of Business Unit Lookups.
For example: fndSetEnabledLookups?q=LookupType=<value1>;LookupCode=<value2>;SetId=<value3>
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 : serviceBusinessUnits-fndSetEnabledLookups-item-response
Type:
Show Source
object
-
BUOrgId: integer
Title:
Business Unit ID
Read Only:true
The unique identifier of the business unit. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the reference set enable lookup. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the reference set enabled lookup was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the reference set enabled lookup value. -
DisplaySequence: integer
(int64)
Title:
Display Sequence
Read Only:true
The display order of the reference set enabled lookup value. -
EndDateActive: string
(date)
Title:
End Date
Read Only:true
The date when the reference set enabled lookup becomes inactive. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the last reference set enabled lookup was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the reference set enabled lookup. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login details of the user who last updated the reference set enabled lookup. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
The code indicating the property of the reference set enabled lookup. -
LookupType: string
Title:
Lookup Type
Read Only:true
Maximum Length:30
The type of the reference set enabled lookup. -
Meaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
The display value of the reference set enabled lookup. -
SetId: integer
(int64)
Title:
Set ID
Read Only:true
The unique identifier of the reference set associated with the lookup. -
StartDateActive: string
(date)
Title:
Start Date
Read Only:true
The date when the reference set enabled lookup becomes active.
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.