Get one applicability
/fscmRestApi/resources/11.13.18.05/meterTemplates/{MeterDefinitionId}/child/MeterApplicability/{ApplicabilityId}
Request
-
ApplicabilityId(required): integer(int64)
Value that uniquely identifies the meter applicability.
-
MeterDefinitionId(required): integer(int64)
Value that uniquely identifies a meter template definition. It is a value that the application generates when it creates a meter template definition. This value is referenced during retrieval and update of a meter template definition. This value cannot be updated after creation.
-
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).
-
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
- application/json
Default Response
-
Metadata-Context(required):
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(required):
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.
object
-
ActiveEndDate: string
(date-time)
Title:
End Date
Date when to stop using the item to create a meter for a new asset. -
ActiveStartDate: string
(date-time)
Title:
Start Date
Date when to start using the item to create a meter for a new asset. -
ApplicabilityId: integer
(int64)
Title:
Applicability ID
Value that uniquely identifies the meter applicability. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item that the meter measures. -
ItemId: integer
(int64)
Value that uniquely identifies the item that the meter measures.
-
ItemNumber: string
Title:
Item Number
Maximum Length:300
Number that identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MasterOrganizationCode: string
Title:
Master Organization
Maximum Length:255
Abbreviation that identifies the organization where the work order creates the item. -
MasterOrganizationId: integer
(int64)
Title:
Master Organization
Value that uniquely identifies the organization where the work order creates the item. -
MeterDefinitionId: integer
(int64)
Title:
Meter Definition ID
Value that uniquely identifies the meter. -
ObjectVersionNumber: integer
(int32)
Number that identifies the object version.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get one meter applicability.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/meterTemplates/MeterDefinitionId/child/MeterApplicability/ApplicabilityId"
For example, the following command gets meter applicability where the meter definition identifier is 300100126599039 and applicability identifier is 300100126599041:
curl -u username:password "https://servername/fscmRestApi/resources/version/meterTemplates/300100126599039/child/MeterApplicability/300100126599041"
The following shows an example of the response body in JSON format.
{ "ActiveEndDate": "2018-08-27T07:00:00+00:00", "ActiveStartDate": "2017-09-03T07:00:00+00:00", "ApplicabilityId": 300100126599041, "MeterDefinitionId": 300100126599039, "MasterOrganizationId": 204, "ObjectVersionNumber": 1, "ItemNumber": "alm-srl-001", "MasterOrganizationCode": "V1", "ItemId": 300100013645842 }
Example cURL Command 2
Use the following cURL command to gets meter applicability using finder ItemAssoByItemAndOrg according to object identifier:
curl -u username:password "https://servername/fscmRestApi/resources/version/meterTemplates/MeterDefinitionId/child/MeterApplicability?finder=ItemAssoByItemAndOrg;ObjectId=ObjectId"
Example Response Body
The following shows an example of the response body in JSON format.
{ "ActiveEndDate": "2018-08-27T07:00:00+00:00", "ActiveStartDate": "2017-09-03T07:00:00+00:00", "ApplicabilityId": 300100126599041, "MeterDefinitionId": 300100126599039, "MasterOrganizationId": 204, "ObjectVersionNumber": 1, "ItemNumber": "alm-srl-001", "MasterOrganizationCode": "V1", "ItemId": 300100013645842 }
Example cURL Command 3
Use the following cURL command to gets meter applicability using finder ItemAssoByItemAndOrg according to organization identifier:
curl -u username:password "https://servername/fscmRestApi/resources/version/meterTemplates/MeterDefinitionId/child/MeterApplicability?finder=ItemAssoByItemAndOrg;MasterOrganizationId=MasterOrgId"
Example Response Body
The following shows an example of the response body in JSON format.
{ "ActiveEndDate": "2018-08-27T07:00:00+00:00", "ActiveStartDate": "2017-09-03T07:00:00+00:00", "ApplicabilityId": 300100126599041, "MeterDefinitionId": 300100126599039, "MasterOrganizationId": 204, "ObjectVersionNumber": 1, "ItemNumber": "alm-srl-001", "MasterOrganizationCode": "V1", "ItemId": 300100013645842 }
Example cURL Command 4
Use the following cURL command to gets meter applicability using finder ItemAssoByItemAndOrg according to applicability identifier:
curl -u username:password "https://servername/fscmRestApi/resources/version/meterTemplates/MeterDefinitionId/child/MeterApplicability?finder=ItemByApplicabilityId;ApplicabilityId=ApplicabilityId"
Example Response Body
The following shows an example of the response body in JSON format.
{ "ActiveEndDate": "2018-08-27T07:00:00+00:00", "ActiveStartDate": "2017-09-03T07:00:00+00:00", "ApplicabilityId": 300100126599041, "MeterDefinitionId": 300100126599039, "MasterOrganizationId": 204, "ObjectVersionNumber": 1, "ItemNumber": "alm-srl-001", "MasterOrganizationCode": "V1", "ItemId": 300100013645842 }