REST API for Oracle Supply Chain Management Cloud

Create one meter

post

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

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

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.
Upsert-Mode:

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

application/json

Root Schema : schema

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.
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
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        }
    }
}

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.

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."
        }
    }
}

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"
	}
	]
}