Get all dimension metadata records
get
/crmRestApi/resources/11.13.18.05/salesForecastDimensionMetadata
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds the sales forecast dimension metadata by primary key.
Finder Variables- MetricDimMetaId; integer; Finds sales forecast dimension metadata for a specified metric dimension metadata identifier.
- PrimaryKey Finds the sales forecast dimension metadata by primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; The user who created the sales forecast dimension metadata.
- CreationDate; string; The date when the sales forecast dimension metadata was created.
- DimSourceFilterCriteria; string; The dimension source filter criteria for the sales forecast dimension metadata is the criteria applied on the dimension source to restrict the values used when creating the dimension.
- DimSourceKeyAttr; string; The name of the attribute that's the unique identifier of the dimension source for the sales forecast dimension metadata.
- DimSourceName; string; The name of the dimension source for the sales forecast dimension metadata. This identifies the data source of a dimension. For lookup based dimensions, this is the lookup type value. For standard or custom object based dimensions this is a valid object name.
- DimSourceNameAttr; string; The dimension source name attribute for the sales forecast dimension metadata is the attribute name that contains the name of the dimension source.
- DimSourceOwnerKeyAttr; string; The dimension source owner key attribute for the sales forecast dimension metadata is the name of the dimension source attribute that contains the unique identifier of the owner. This is relevant when a dimension represents a sales forecast participant.
- DimSourceParentKeyAttr; string; The dimension source parent key attribute for the sales forecast dimension metadata is the name of the primary key attribute that identifies the parent of the dimension source. This is relevant when a dimension is hierarchical.
- DimSourceType; string; The type of dimension source which can be based on a lookup type, standard object or custom object. The values accepted are LOOKUP or CUSTOM.
- KeyMapSql; string; The key map SQL statement for the sales forecast dimension metadata is generated when the dimension source type is lookup.
- LastUpdateDate; string; The date when the sales forecast dimension metadata was last updated.
- LastUpdateLogin; string; The login of the user who last updated the sales forecast dimension metadata.
- LastUpdatedBy; string; The user who last updated the sales forecast dimension metadata.
- MetricDimCode; string; The code that uniquely identifies a sales forecast metric dimension such as TERRITORY and PRODUCT.
- MetricDimMetaId; integer; The metric dimension metadata identifier for the sales forecast metric dimension metadata is a generated primary key to uniquely identify each metadata record.
- ObjectVersionNumber; integer; The object version number for the sales forecast dimension metadata.
- RootDimKeySql; string; The root dimension key SQL statement for the sales forecast dimension metadata is generated based on the dimension source.
- SourceSql; string; The source SQL statement for the sales forecast dimension metadata is generated for lookup and object based dimensions.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : salesForecastDimensionMetadata
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : salesForecastDimensionMetadata-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the sales forecast dimension metadata. -
CreationDate: string
(date-time)
Read Only:
true
The date when the sales forecast dimension metadata was created. -
DimSourceFilterCriteria: string
Maximum Length:
4000
The dimension source filter criteria for the sales forecast dimension metadata is the criteria applied on the dimension source to restrict the values used when creating the dimension. -
DimSourceKeyAttr: string
Maximum Length:
1000
The name of the attribute that's the unique identifier of the dimension source for the sales forecast dimension metadata. -
DimSourceName: string
Maximum Length:
1000
The name of the dimension source for the sales forecast dimension metadata. This identifies the data source of a dimension. For lookup based dimensions, this is the lookup type value. For standard or custom object based dimensions this is a valid object name. -
DimSourceNameAttr: string
Maximum Length:
1000
The dimension source name attribute for the sales forecast dimension metadata is the attribute name that contains the name of the dimension source. -
DimSourceOwnerKeyAttr: string
Maximum Length:
1000
The dimension source owner key attribute for the sales forecast dimension metadata is the name of the dimension source attribute that contains the unique identifier of the owner. This is relevant when a dimension represents a sales forecast participant. -
DimSourceParentKeyAttr: string
Maximum Length:
1000
The dimension source parent key attribute for the sales forecast dimension metadata is the name of the primary key attribute that identifies the parent of the dimension source. This is relevant when a dimension is hierarchical. -
DimSourceType: string
Maximum Length:
30
The type of dimension source which can be based on a lookup type, standard object or custom object. The values accepted are LOOKUP or CUSTOM. -
KeyMapSql: string
Read Only:
true
Maximum Length:4000
The key map SQL statement for the sales forecast dimension metadata is generated when the dimension source type is lookup. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the sales forecast dimension metadata was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the sales forecast dimension metadata. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the sales forecast dimension metadata. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MetricDimCode: string
Maximum Length:
100
The code that uniquely identifies a sales forecast metric dimension such as TERRITORY and PRODUCT. -
MetricDimMetaId: integer
(int64)
The metric dimension metadata identifier for the sales forecast metric dimension metadata is a generated primary key to uniquely identify each metadata record.
-
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number for the sales forecast dimension metadata. -
RootDimKeySql: string
Read Only:
true
Maximum Length:4000
The root dimension key SQL statement for the sales forecast dimension metadata is generated based on the dimension source. -
SourceSql: string
Read Only:
true
Maximum Length:4000
The source SQL statement for the sales forecast dimension metadata is generated for lookup and object based dimensions.
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.