REST API for Oracle Fusion Cloud SCM

Get all applicabilities

get

/fscmRestApi/resources/11.13.18.05/meterTemplates/{MeterDefinitionId}/child/MeterApplicability

Request

Path Parameters

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.

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:
- ItemAssoByItemAndOrg: Find the applicability according to item identifier and organization identifier.
  Finder Variables:
  - MasterOrganizationId; integer; Value that uniquely identifies the item.
  - ObjectId; integer; Value that uniquely identifies the organization.
- ItemByApplicabilityId: Find the applicability according to the value that identifies the applicability as the primary key.
  Finder Variables:
  - ApplicabilityId; integer; Value that uniquely identifies the applicability.
- PrimaryKey: Find the applicability according to the value that identifies the applicability.
  Finder Variables:
  - ApplicabilityId; integer; Value that uniquely identifies the applicability.
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:
- ActiveEndDate; string; Date when to stop using the item to create a meter for a new asset.
- ActiveStartDate; string; Date when to start using the item to create a meter for a new asset.
- ApplicabilityId; integer; Value that uniquely identifies the meter applicability.
- ItemDescription; string; Description of the item that the meter measures.
- ItemId; integer; Value that uniquely identifies the item that the meter measures.
- ItemNumber; string; Number that identifies the item.
- MasterOrganizationCode; string; Abbreviation that identifies the organization where the work order creates the item.
- MasterOrganizationId; integer; Value that uniquely identifies the organization where the work order creates the item.
- MeterDefinitionId; integer; Value that uniquely identifies the meter.
- ObjectVersionNumber; integer; Number that identifies the object version.
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.

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

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.

Root Schema : meterTemplates-MeterApplicability

Type: object

Show Source

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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/meterTemplates-MeterApplicability-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object meterTemplates-MeterApplicability-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/meterTemplates-MeterApplicability-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : meterTemplates-MeterApplicability-item-response

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "MasterOrganizationCode":{
            "title":"Master Organization",
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization where the work order creates the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when to start using the item to create a meter for a new asset.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "title":"Meter Definition ID",
            "type":"integer",
            "description":"Value that uniquely identifies the meter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "MasterOrganizationId":{
            "title":"Master Organization",
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the work order creates the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item that the meter measures.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that the meter measures.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when to stop using the item to create a meter for a new asset.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicabilityId":{
            "title":"Applicability ID",
            "type":"integer",
            "description":"Value that uniquely identifies the meter applicability.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Examples

This example describes how to get all meter applicabilities.

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"

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
}