Jump to

• Request
• Response
• Examples

Update one applicability

patch

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

Request

Path Parameters

• 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.

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.
• 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":{
        "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
        },
        "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
        },
        "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"
            }
        },
        "MeterDefinitionId":{
            "title":"Meter Definition ID",
            "type":"integer",
            "description":"Value that uniquely identifies the meter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        }
    }
}

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 : 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":{
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "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"
            }
        }
    }
}

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

Examples

This example describes how to update a meter applicability.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/versionmeterTemplates/MeterDefinitionId/child/MeterApplicability/ApplicabilityId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
   "MasterOrganizationId": 204,
   "ActiveStartDate": "2017-09-03T00:00:00-07:00",
   "ActiveEndDate": "2018-08-27T00:00:00-07:00",
   "ItemNumber": "alm-srl-001"
}

Example Response Body

The following example includes the contents 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
}

The following example includes the contents of the request body in JSON format to update the end date. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
  "ActiveEndDate": "2018-08-27T07:00:00+00:00"
}

Example Response Body

The following example includes the contents 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
}

Back to Top