Get all measures
get
/fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitions/{DocumentId}/child/measures
Request
Path Parameters
-
DocumentId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 -
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 Find measures according to the primary identifier.
Finder Variables- DocumentMeasureId; integer; Value that uniquely identifies the measure.
- PrimaryKey Find measures according to the primary identifier.
-
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; User who created the document measure.
- CreationDate; string; Date and time when the user created the document measure.
- DataTypeCode; string; Abbreviation that identifies the type of measure data.
- DocumentMeasureId; integer; Value that uniquely identifies the document measure.
- LastUpdateDate; string; Date and time when the user most recently updated the document measure.
- LastUpdatedBy; string; User who most recently updated the document measure.
- MeasureId; integer; Value that uniquely identifies the measure definition.
- MeasureTypeCode; string; Abbreviation that identifies the type of measure used for collaboration.
- MeasureTypeName; string; Name of the type of measure used for collaboration.
- ParticipantOwnerCode; string; Abbreviation that identifies the measure's participant owner. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.
- ParticipantOwnerName; string; Name of the measure's owning participant.
-
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 : collaborationDocumentDefinitions-measures
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 : collaborationDocumentDefinitions-measures-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the document measure. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the document measure. -
DataTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the type of measure data. -
DocumentMeasureId: integer
(int64)
Read Only:
true
Value that uniquely identifies the document measure. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the document measure. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the document measure. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
measureActions: array
Measure Actions
Title:
Measure Actions
The Measure Actions resource manages the actions associated with a document measure. -
MeasureId: integer
(int64)
Value that uniquely identifies the measure definition.
-
measureParameters: array
Measure Parameters
Title:
Measure Parameters
The Measure Parameters resource manages the parameters associated with the document measures. -
MeasureTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of measure used for collaboration. -
MeasureTypeName: string
Name of the type of measure used for collaboration.
-
ParticipantOwnerCode: string
Maximum Length:
30
Abbreviation that identifies the measure's participant owner. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE. -
ParticipantOwnerName: string
Read Only:
true
Maximum Length:80
Name of the measure's owning participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Measure Actions
Type:
array
Title:
Measure Actions
The Measure Actions resource manages the actions associated with a document measure.
Show Source
Nested Schema : Measure Parameters
Type:
array
Title:
Measure Parameters
The Measure Parameters resource manages the parameters associated with the document measures.
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.
Nested Schema : collaborationDocumentDefinitions-measures-measureActions-item-response
Type:
Show Source
object
-
ActionCode: string
Maximum Length:
30
Abbreviation that identifies the type of action for a document measure. A list of accepted values is defined in the lookup type ORA_VCS_MEASURE_ACTIONS. -
ActionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the action for a document measure. -
ActionName: string
Name of the action for a document measure.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the measure action. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the measure action. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the measure action. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the measure action. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
measureActionParticipants: array
Measure Action Participants
Title:
Measure Action Participants
The Measure Action Participants resource manages the participants associated with an action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Measure Action Participants
Type:
array
Title:
Measure Action Participants
The Measure Action Participants resource manages the participants associated with an action.
Show Source
Nested Schema : collaborationDocumentDefinitions-measures-measureActions-measureActionParticipants-item-response
Type:
Show Source
object
-
ActionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the action for a document measure. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the measure action participant. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the measure action participant. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the measure action participant. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the measure action participant. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantCode: string
Maximum Length:
30
Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE. -
ParticipantId: integer
(int64)
Read Only:
true
Value that uniquely identifies the participant for an action. -
ParticipantName: string
Maximum Length:
255
Name of the participant for an action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : collaborationDocumentDefinitions-measures-measureParameters-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the measure parameter. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the measure parameter. -
InstanceParameterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the instance of the measure parameter. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the measure parameter. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the measure parameter. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParameterCode: string
Maximum Length:
100
Abbreviation that identifies the parameter on the document measure. -
ParameterName: string
Read Only:
true
Maximum Length:80
Name of the parameter of the document measure. -
ParameterValue: string
Maximum Length:
255
Value of the parameter of the document measure. -
SecondParameterValue: string
Maximum Length:
255
Second value of the parameter of the document measure. A list of accepted values is defined in the lookup type ORA_VCS_MEASURE_BOUNDARY_TYPE when the ParameterCode is MEASURE_HISTORY, MEASURE_HORIZON, or LOCKED_FENCE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source