Jump to

• Request
• Response
• Examples

Update one affected asset

patch

/fscmRestApi/resources/11.13.18.05/maintenancePrograms/{MaintenanceProgramId}/child/workRequirements/{WorkRequirementId}/child/affectedAssets/{affectedAssetsUniqID}

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.
• affectedAssetsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Affected Assets resource and used to uniquely identify an instance of Affected Assets. The client should not generate the hash key value. Instead, the client should query on the Affected Assets collection resource in order to navigate to a specific instance of Affected Assets to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• CreateWorkOrderOptionCode: string
  Title: Create Work Orders Option Code

  Maximum Length: 30

  Abbreviation that identifies if work orders will be automatically or manually created for the affected asset. Valid values are ORA_AUTOMATIC and ORA_MANUALLY as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. The default value is Automatic and 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.
• MaintenanceOrganizationId: integer (int64)
  Title: Maintenance Organization

  Value that uniquely identifies the operating organization of the asset. The value may be the same as the operating organization or may be another maintenance-enabled organization. This value is read-only.
• OperatingOrganizationId: integer (int64)
  Title: Operating Organization ID

  Value that uniquely identifies the operating organization of the asset. This value is read-only.

{
    "type":"object",
    "properties":{
        "AssetStatusCode":{
            "title":"Asset Status Code",
            "maxLength":"11",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "ForecastStartDate":{
            "title":"Forecasted Start Date",
            "type":"string",
            "description":"Date when the work requirement begins forecasting the asset. This value can be updated after its creation until the first work order is created.",
            "format":"date",
            "nullable":true
        },
        "HistoricalLastCompletedDate":{
            "title":"Historical Last Completed Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true
        },
        "OperatingOrganizationId":{
            "title":"Operating Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the operating organization of the asset. This value is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "HistoricalLastCompleteInterval":{
            "title":"Historical Last Completed Interval",
            "type":"number",
            "description":"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.",
            "nullable":true
        },
        "CreateWorkOrderOptionCode":{
            "title":"Create Work Orders Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies if work orders will be automatically or manually created for the affected asset. Valid values are ORA_AUTOMATIC and ORA_MANUALLY as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. The default value is Automatic and the code can be updated.",
            "nullable":true
        },
        "MaintenanceOrganizationId":{
            "title":"Maintenance Organization",
            "type":"integer",
            "description":"Value that uniquely identifies the operating organization of the asset. The value may be the same as the operating organization or may be another maintenance-enabled organization. This value is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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-affectedAssets-item-response

Type: object

Show Source

• 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.
• CreateWorkOrderOption: string
  Title: Create Work Orders Option

  Read Only: true

  Maximum Length: 80

  Name that identifies if work orders will be automatically or manually created for the work requirement. This value is read-only.
• CreateWorkOrderOptionCode: string
  Title: Create Work Orders Option Code

  Maximum Length: 30

  Abbreviation that identifies if work orders will be automatically or manually created for the affected asset. Valid values are ORA_AUTOMATIC and ORA_MANUALLY as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. The default value is Automatic and 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.
• MaintenanceOrganization: string
  Title: Maintenance Organization

  Read Only: true

  Maximum Length: 18

  Abbreviation that uniquely identifies the operating organization of the asset. The value may be the same as the operating organization or may be another maintenance-enabled organization. This value is read-only.
• MaintenanceOrganizationId: integer (int64)
  Title: Maintenance Organization

  Value that uniquely identifies the operating organization of the asset. The value may be the same as the operating organization or may be another maintenance-enabled organization. This value is read-only.
• OperatingOrganization: string
  Title: Operating Organization

  Read Only: true

  Maximum Length: 18

  Abbreviation that uniquely identifies the operating organization of the asset. This value is read-only.
• OperatingOrganizationId: integer (int64)
  Title: Operating Organization ID

  Value that uniquely identifies the operating organization of the asset. This value is read-only.
• 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.

{
    "type":"object",
    "properties":{
        "OperatingOrganizationId":{
            "title":"Operating Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the operating organization of the asset. This value is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssetDescription":{
            "title":"Asset Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the asset in a work requirement. This value can't be updated,.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowWorkOrdersFlag":{
            "title":"Allow Work Orders",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoricalLastCompleteInterval":{
            "title":"Historical Last Completed Interval",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetStatus":{
            "title":"Asset Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the asset status code. This value can't be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OperatingOrganization":{
            "title":"Operating Organization",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the operating organization of the asset. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies the asset in a work requirement. This value can't be updated,.",
            "nullable":true,
            "x-queryable":true
        },
        "MaintenanceOrganizationId":{
            "title":"Maintenance Organization",
            "type":"integer",
            "description":"Value that uniquely identifies the operating organization of the asset. The value may be the same as the operating organization or may be another maintenance-enabled organization. This value is read-only.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrdersCreatedFlag":{
            "title":"Work Orders Created",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetStatusCode":{
            "title":"Asset Status Code",
            "maxLength":"11",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ForecastStartDate":{
            "title":"Forecasted Start Date",
            "type":"string",
            "description":"Date when the work requirement begins forecasting the asset. This value can be updated after its creation until the first work order is created.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Serial number of the asset in a work requirement. This value can't be updated,.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreateWorkOrderOption":{
            "title":"Create Work Orders Option",
            "maxLength":"80",
            "type":"string",
            "description":"Name that identifies if work orders will be automatically or manually created for the work requirement. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HistoricalLastCompletedDate":{
            "title":"Historical Last Completed Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "MaintenanceOrganization":{
            "title":"Maintenance Organization",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the operating organization of the asset. The value may be the same as the operating organization or may be another maintenance-enabled organization. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreateWorkOrderOptionCode":{
            "title":"Create Work Orders Option Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies if work orders will be automatically or manually created for the affected asset. Valid values are ORA_AUTOMATIC and ORA_MANUALLY as defined in the lookup ORA_MNT_MX_PROGRAM_WO_CREATE. The default value is Automatic and the code can be updated.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"Value that uniquely identifies the asset in a work requirement This value can't be updated,.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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

Examples

This example describes how to update one affected asset.

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/version/maintenancePrograms/MaintenanceProgramId/child/workRequirements/WorkRequirementId/child/affectedAssets/affectedAssetsUniqID"

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.

{
"AssetStatusCode": "ORA_EXCLUDE"
}

Example Response Body

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

{
	"AssetNumber": "ASSET_002",
	"AssetDescription": "ASSET_002 DESC",
	"SerialNumber": "ASSET_002_SN102",
	"AllowWorkOrdersFlag": true,
	"WorkOrdersCreatedFlag": null,
	"AssetStatusCode": "ORA_EXCLUDE",
	"AssetStatus": "Excluded",
	"HistoricalLastCompletedDate": null,
	"HistoricalLastCompleteInterval": null
	"ForecastStartDate": null,
	"CreateWorkOrderOptionCode": "ORA_AUTOMATIC",
	"CreateWorkOrderOption": "Automatically",
	"OperatingOrganizationId": 123456789101112,
	"OperatingOrganization": "OPS_ORG_A",
	"MaintenanceOrganizationId": 123456789101112,
	"MaintenanceOrganization": "OPS_ORG_A",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100601683585/child/workRequirements/300100601683588/child/affectedAssets/00020000000EACED00057708000110F09DC2AF670000000EACED00057708000110F09DC29E84",
            "name": "affectedAssets",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100601683585/child/workRequirements/300100601683588/child/affectedAssets/00020000000EACED00057708000110F09DC2AF670000000EACED00057708000110F09DC29E84",
            "name": "affectedAssets",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/maintenancePrograms/300100601683585/child/workRequirements/300100601683588",
            "name": "workRequirements",
            "kind": "item"
        }
    ]
}

Back to Top