Create one affected asset
post
/fscmRestApi/resources/11.13.18.05/maintenancePrograms/{MaintenanceProgramId}/child/workRequirements/{WorkRequirementId}/child/affectedAssets
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:
Show Source
object
-
AssetId: integer
(int64)
Title:
Asset ID
Value that uniquely identifies the asset in a work requirement This value can't be updated,. -
AssetNumber: string
Title:
Asset Number
Maximum Length:80
Number that uniquely identifies the asset in a work requirement. This value can't be updated,. -
AssetStatusCode: string
Title:
Asset Status Code
Maximum Length:11
Abbreviation that specifies if an asset is included or excluded from the forecast in a work requirement. Valid values are ORA_INCLUDE or ORA_EXCLUDE as defined in the lookup ORA_MNT_AFF_ASSET_STATUS. The code can be updated. -
ForecastStartDate: string
(date)
Title:
Forecasted Start Date
Date when the work requirement begins forecasting the asset. This value can be updated after its creation until the first work order is created. -
HistoricalLastCompletedDate: string
(date)
Title:
Historical Last Completed Date
Historical date of accomplishment of the work requirement from an external system. This value can be updated after its creation until the first work order is created. -
HistoricalLastCompleteInterval: number
Title:
Historical Last Completed Interval
Historical cycle interval of accomplishment of the work requirement from an external system. This value can be updated after its creation until the first work order is created.
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 : maintenancePrograms-workRequirements-affectedAssets-item-response
Type:
Show Source
object
-
AllowWorkOrdersFlag: boolean
Title:
Allow Work Orders
Read Only:true
Maximum Length:1
Contains one of the following values: true or false. If true, then work orders are allowed to be created for the applicable asset in the work requirement. If false, then work orders can't be created for the applicable asset. The default value is false. This value can't be updated. -
AssetDescription: string
Title:
Asset Description
Read Only:true
Maximum Length:240
Description of the asset in a work requirement. This value can't be updated,. -
AssetId: integer
(int64)
Title:
Asset ID
Value that uniquely identifies the asset in a work requirement This value can't be updated,. -
AssetNumber: string
Title:
Asset Number
Maximum Length:80
Number that uniquely identifies the asset in a work requirement. This value can't be updated,. -
AssetStatus: string
Title:
Asset Status
Read Only:true
Maximum Length:80
Meaning of the asset status code. This value can't be updated. -
AssetStatusCode: string
Title:
Asset Status Code
Maximum Length:11
Abbreviation that specifies if an asset is included or excluded from the forecast in a work requirement. Valid values are ORA_INCLUDE or ORA_EXCLUDE as defined in the lookup ORA_MNT_AFF_ASSET_STATUS. The code can be updated. -
ForecastStartDate: string
(date)
Title:
Forecasted Start Date
Date when the work requirement begins forecasting the asset. This value can be updated after its creation until the first work order is created. -
HistoricalLastCompletedDate: string
(date)
Title:
Historical Last Completed Date
Historical date of accomplishment of the work requirement from an external system. This value can be updated after its creation until the first work order is created. -
HistoricalLastCompleteInterval: number
Title:
Historical Last Completed Interval
Historical cycle interval of accomplishment of the work requirement from an external system. This value can be updated after its creation until the first work order is created. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SerialNumber: string
Title:
Serial Number
Read Only:true
Maximum Length:80
Serial number of the asset in a work requirement. This value can't be updated,. -
WorkOrdersCreatedFlag: boolean
Title:
Work Orders Created
Read Only:true
Maximum Length:1
Contains one of the following values: true or false. If true, then work orders for the work requirement exist. If false, then work orders for the work requirements haven't been created yet. The default value is false. This value can't be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.