Create one meter

post

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

Request

Path Parameters
  • 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.
  • 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.
Header Parameters
  • 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".
  • 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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • 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.
  • 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 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.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
  • 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.
  • 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.
  • 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
  • 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.
  • 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 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.
Back to Top

Examples

This example describes how to create a meter.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/maintenancePrograms/MaintenanceProgramId/child/workRequirements/WorkRequirementId/child/meters"

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

{
	"Name": "METER_ON_CYCLE",
	"TypeCode":"ORA_ITEM",
	"InventoryItemNumber": "alm-lot-srl-001",
	"ActiveStartDate": "2019-03-06T00:00:00-08:00",
	"ForecastUsingACycleFlag": "Y",
	"IntervalsInTheCycle": 7,
	"NextWorkOrderOnlyFlag": "Y",
	"CalendarBasedFlag": "N",
	"MeterBasedFlag": "Y",
	"ConditionBasedFlag": "N",
	"OverrideSuppressMergeFlag": "N",
	"CalendarPatternName": null,
	"meters":[
	{
		"Name": "UTIL_METER_1",
		"BaseInterval":10,
		"CalculateNextDueCode": "ORA_BASE_INTERVAL"
	}
	],
	"workDefinitions":[
	{
		"Name": "Weekly Maintenance",
		"RepeatsInCycleFlag": "Y",
		"DueAtCycleInterval": 7
	},
	{
		"Name": "Daily Maintenance",
		"RepeatsInCycleFlag": "Y",
		"DueAtCycleInterval": 1
	}
	]
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"Name": "METER_ON_CYCLE",
	"WorkRequirementId": 300100179966822,
	"TypeCode": "ORA_ITEM",
	"InventoryItemId": 300100013645864,
	"InventoryItemNumber": "alm-lot-srl-001",
	"AssetId": null,
	"AssetNumber": null,
	"ActiveStartDate": "2019-03-06",
	"ActiveEndDate": null,
	"ForecastUsingACycleFlag": true,
	"IntervalsInTheCycle": 7,
	"NextWorkOrderOnlyFlag": true,
	"CalendarBasedFlag": false,
	"CalendarPatternId": null,
	"MeterBasedFlag": true,
	"ConditionBasedFlag": false,
	"SuppressMergeCode": null,
	"OverrideSuppressMergeFlag": false,
	"CalendarPatternName": null,
	"SuppressMergeCodeDescription": null,
	"workDefinitions": [
	{
		"RepeatsInCycleFlag": true,
		"DisabledFlag": false,
		"DueAtCycleInterval": 7,
		"WorkDefinitionRequirementId": 300100179966827,
		"WorkDefinitionMaintenanceNameId": null,
		"Name": null,
		"WorkDefinitionId": 300100118178830,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822/child/workDefinitions/300100179966827",
			"name": "workDefinitions",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822/child/workDefinitions/300100179966827",
			"name": "workDefinitions",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822",
			"name": "workRequirements",
			"kind": "item"
		}
		]
	},
	{
		"RepeatsInCycleFlag": true,
		"DisabledFlag": false,
		"DueAtCycleInterval": 1,
		"WorkDefinitionRequirementId": 300100179966828,
		"WorkDefinitionMaintenanceNameId": null,
		"Name": null,
		"WorkDefinitionId": 300100118178763,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822/child/workDefinitions/300100179966828",
			"name": "workDefinitions",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822/child/workDefinitions/300100179966828",
			"name": "workDefinitions",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822",
			"name": "workRequirements",
			"kind": "item"
		}
		]
	}
	],
	"meters": [
	{
		"BaseInterval": 10,
		"MeterIntervalId": 300100179966825,
		"DisabledFlag": false,
		"MeterDefinitionId": 300100179879944,
		"CalculateNextDueCode": "ORA_BASE_INTERVAL",
		"Name": "UTIL_METER_1",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822/child/meters/300100179966825",
			"name": "meters",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822/child/meters/300100179966825",
			"name": "meters",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822",
			"name": "workRequirements",
			"kind": "item"
		}
		]
	}
	],
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822",
		"name": "workRequirements",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822",
		"name": "workRequirements",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471",
		"name": "maintenancePrograms",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822/child/workDefinitions",
		"name": "workDefinitions",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822/child/meters",
		"name": "meters",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100179940471/child/workRequirements/300100179966822/child/conditionEvents",
		"name": "conditionEvents",
		"kind": "collection"
	}
	]
}

Back to Top