Given a list of node IDs within a single dimension, returns an expanded list of
dimension node objects which include details of each node's label, name, parent
aspects, and the values of specifically-requested attributes (if any). Nodes appear
in the result in the same order as originally specified in the request. If a requested
node does not exist, it is represented by a null value in the result list.
Path Elements
+dimension
0.17required
string
The URI path to a specific dimension (whether
by ID or
by name).
Request Headers
pros-dimension-consistency
0.13optional
string
pros-dimension-consistency is an optional HTTP header used to define the data consistency
level of the request. There is a trade off between data consistency and service availability
and performance: higher data consistency can result in lower availability and slower
performance, while lower data consistency can result in higher availability and faster
performance.
0.13
valid values:
HIGHEST
HIGH
NORMAL
LOW
LOWEST
pros-dimension-include
0.17optional
string
pros-dimension-include is an optional HTTP header used for clients
to indicate whether data values that are omitted by default should
be returned by APIs of the PROS Dimension Service. Its value consists
of one or more values as listed below. When multiple values are specified,
the ASCII comma charater must be used as a separator.
There is a trade-off between data completeness and service performance.
Higher data completeness may result in lower availability and/or lower performance.
When node.ancestor.id is specified, a result set of a request
that returns dimension nodes contains members exposing their ancestor
node IDs as well as other properties.
When node.ancestor.name is specified, a result set of a request
that returns dimension nodes contains members exposing their ancestor node
names as well as other properties.
When node.aspect.name is specified, a result set of a request
that returns dimension nodes contains members exposing their aspect
names alongside their aspect IDs.
When node.label.allLocales is specified, a result set of a request
that returns dimension nodes contains members exposing the whole list
of labels corresponding to all available locales as well as other properties.
0.17
valid values:
node.ancestor.id
node.ancestor.name
node.aspect.name
node.label.allLocales
Request Body
id
0.17required
string
One or more dimension node IDs that are expanded.
0.17
min length:
1
0.17
max length:
100
attrID
0.21optional
string
IDs of the dimension attributes whose values are requested. If any given attribute IDs are not defined in
this dimension, error will be reported in the response along with BAD_REQUEST http status.
This parameter can be repeated but each value should refer to a different attribute of the
dimension.
attrName
0.21optional
string
Names of the dimension attributes whose values are requested. If any given attribute names are not defined in
this dimension, error will be reported in the response along with BAD_REQUEST http status.
This parameter can be repeated but each value should refer to a different attribute of the
dimension.
Extended description
This method provides a batch operation to retrieve details of multiple
dimension nodes in the context of a particular dimension,
given that their node IDs are known. Instead of multiple
calls of GET {+dimension}/nodes/id/{id}
on each dimension node ID, a single call to this method with the
dimension node IDs passed in as parameters retrieves the same result
more efficiently. The optional attrID and attrName can be provided
at the same time. However, they should represent different attributes
of the dimension. Request an unknown attribute to the dimension results in BAD_REQUEST.
If a node does not have a value for the requested attribute, the attribute will be absent
from that node in the response. Use pros-dimension-include header with
node.ancestor.id value to request ancestor ID and ancestor aspect ID pairs
of the nodes. Ancestor ID and ancestor aspect ID pairs are not included in the response by
default.
The response header pros-batch-errors indicates the number of elements with
errors in the response body.
This header is only returned when the status code is 200 and errors are present in the
response, otherwise the header is omitted.