Jump to

• Request
• Response

Get one meter

get

/fscmRestApi/resources/11.13.18.05/maintenancePrograms/{MaintenanceProgramId}/child/workRequirements/{WorkRequirementId}/child/meters/{MeterIntervalId}

Request

Path Parameters

• MaintenanceProgramId(required): integer(int64)
  Value that uniquely identifies a maintenance program. The application generates this value and is referenced during retrieval and update of a maintenance program definition. This value can't be updated after its creation.
• MeterIntervalId(required): integer(int64)
  Value that identifies a unique meter within a work requirement. The application generates this value when a meter is associated with a work requirement. This value can't be updated after its creation.
• WorkRequirementId(required): integer(int64)
  Value that uniquely identifies the work requirement. The application generates this value when it creates a new requirement. This value is referenced during retrieval and update of a work requirement. This value can't be updated after its 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
• 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).

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 Top

Response

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.

Body ()

Root Schema : maintenancePrograms-workRequirements-meters-item-response

Type: object

Show Source

• BaseInterval: number
  Title: Base Interval

  Value of the interval that's used to calculate how often the forecast is due. This value can be updated after its creation.
• CalculateNextDueCode: string
  Title: Method to Calculate Next Due

  Maximum Length: 30

  Abbreviation that specifies how the next due forecast interval is calculated. Valid values are ORA_BASE_INTERVAL or ORA_LAST_COMPLETION. This value can be updated after its creation.
• DisabledFlag: boolean
  Maximum Length: 1

  Default Value: false

  Value that indicates whether a meter is disabled or not. Contains one of the following values: true or false. If true, then the meter is disabled. If false, then the meter isn't disabled. If there are work orders created for the work requirement, this attribute is set to true when deleting a meter.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeterDefinitionId: integer (int64)
  Value that uniquely identifies the asset meter used to forecast a work requirement. Either meter name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.
• MeterIntervalId: integer (int64)
  Value that identifies a unique meter within a work requirement. The application generates this value when a meter is associated with a work requirement. This value can't be updated after its creation.
• Name: string
  Name of the meter used to forecast a work requirement. Either meter name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.

{
    "type":"object",
    "properties":{
        "DisabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates whether a meter is disabled or not. Contains one of the following values: true or false. If true, then the meter is disabled. If false, then the meter isn't disabled. If there are work orders created for the work requirement, this attribute is set to true when deleting a meter.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset meter used to forecast a work requirement. Either meter name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BaseInterval":{
            "title":"Base Interval",
            "type":"number",
            "description":"Value of the interval that's used to calculate how often the forecast is due. This value can be updated after its creation.",
            "nullable":false,
            "x-queryable":true
        },
        "CalculateNextDueCode":{
            "title":"Method to Calculate Next Due",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that specifies how the next due forecast interval is calculated. Valid values are ORA_BASE_INTERVAL or ORA_LAST_COMPLETION. This value can be updated after its creation.",
            "nullable":false,
            "x-queryable":true
        },
        "MeterIntervalId":{
            "type":"integer",
            "description":"Value that identifies a unique meter within a work requirement. The application generates this value when a meter is associated with a work requirement. This value can't be updated after its creation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"Name of the meter used to forecast a work requirement. Either meter name or ID can be used during a POST, PATCH, or GET action. This value can only be updated after its creation until work orders have been created.",
            "nullable":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."
        }
    }
}

Back to Top