Update
patch
/fscmRestApi/resources/11.13.18.05/assetFailureSets/{FailureSetId}
Request
Path Parameters
-
FailureSetId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
Root Schema : schema
Type:
Show Source
object-
failureAssociations: array
Failure Associations
Title:
Failure Associations -
failureChainCauses: array
Failure Chain Causes
Title:
Failure Chain Causes -
failureChainFailures: array
Failure Chain Failures
Title:
Failure Chain Failures -
failureChainResolutions: array
Failure Chain Resolutions
Title:
Failure Chain Resolutions -
failureChains: array
Failure Chains
Title:
Failure Chains -
FailureChainsEnforcedFlag: boolean
Title:
Failure Chains EnforcedMaximum Length:1 -
FailureSetCode(required): string
Title:
Failure Set CodeMaximum Length:30 -
FailureSetDescription: string
Title:
Failure Set DescriptionMaximum Length:540 -
FailureSetName: string
Title:
Failure Set NameMaximum Length:240
Nested Schema : schema
Type:
Show Source
object-
CaptureRequiredCode: string
Title:
Capture RequiredMaximum Length:1Default Value:N -
FailureAssociationDisableFlag: boolean
Title:
Disable -
FailureSetId: integer
(int64)
Title:
Failure Set ID -
ItemCategoryId: integer
-
ObjectTypeCode: string
Title:
Object Type CodeMaximum Length:30
Nested Schema : assetFailureSets-failureChainResolutions-item-patch-request
Type:
Show Source
objectNested Schema : schema
Type:
Show Source
object-
FailureChainDisableFlag: boolean
Title:
Disable -
FailureSetId: integer
(int64)
Title:
Failure Set ID
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 : assetFailureSets-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
DefaultFlag: boolean
Read Only:
trueMaximum Length:80 -
failureAssociations: array
Failure Associations
Title:
Failure Associations -
failureChainCauses: array
Failure Chain Causes
Title:
Failure Chain Causes -
failureChainFailures: array
Failure Chain Failures
Title:
Failure Chain Failures -
failureChainResolutions: array
Failure Chain Resolutions
Title:
Failure Chain Resolutions -
failureChains: array
Failure Chains
Title:
Failure Chains -
FailureChainsEnforcedFlag: boolean
Title:
Failure Chains EnforcedMaximum Length:1 -
FailureSetCode: string
Title:
Failure Set CodeMaximum Length:30 -
FailureSetDescription: string
Title:
Failure Set DescriptionMaximum Length:540 -
FailureSetId: integer
(int64)
Title:
Failure Set IDRead Only:true -
FailureSetName: string
Title:
Failure Set NameMaximum Length:240 -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : assetFailureSets-failureAssociations-item-response
Type:
Show Source
object-
ActiveEndDate: string
(date-time)
Title:
Active End DateRead Only:true -
AssetDescription: string
Title:
Asset DescriptionRead Only:trueMaximum Length:255 -
AssetId: integer
Title:
Asset ID -
AssetNumber: string
Title:
Asset NumberMaximum Length:255 -
CaptureRequiredCode: string
Title:
Capture RequiredMaximum Length:1Default Value:N -
CaptureRequiredName: string
Title:
MeaningRead Only:trueMaximum Length:80 -
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
FailureAssociationDisableFlag: boolean
Title:
Disable -
FailureSetId: integer
(int64)
Title:
Failure Set ID -
ItemCategoryCode: string
Title:
Item Category CodeMaximum Length:255 -
ItemCategoryDescription: string
Read Only:
trueMaximum Length:240 -
ItemCategoryId: integer
-
ItemCategoryName: string
Title:
Item Category NameMaximum Length:255 -
ItemDescription: string
Read Only:
trueMaximum Length:255 -
ItemId: integer
Read Only:
true -
ItemNumber: string
Title:
Item NumberMaximum Length:255 -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MasterOrganizationCode: string
Maximum Length:
255 -
MasterOrganizationId: integer
(int64)
-
ObjectTypeCode: string
Title:
Object Type CodeMaximum Length:30 -
ObjectTypeMeaning: string
Read Only:
trueMaximum Length:240 -
SetAssociationId: integer
(int64)
Title:
Set Association IDRead Only:true
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : assetFailureSets-failureChainCauses-item-response
Type:
Show Source
object-
ActiveEndDate: string
(date-time)
Read Only:
true -
CauseCode: string
Read Only:
trueMaximum Length:30 -
CauseCodeId: integer
(int64)
Read Only:
true -
CauseDescription: string
Read Only:
trueMaximum Length:540 -
CauseName: string
Read Only:
trueMaximum Length:240 -
FailureCodeId: integer
Read Only:
true -
FailureSetId: integer
(int64)
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : assetFailureSets-failureChainFailures-item-response
Type:
Show Source
object-
ActiveEndDate: string
(date-time)
Read Only:
true -
FailureCode: string
Read Only:
trueMaximum Length:30 -
FailureCodeId: integer
Read Only:
true -
FailureDescription: string
Read Only:
trueMaximum Length:540 -
FailureName: string
Read Only:
trueMaximum Length:240 -
FailureSetId: integer
(int64)
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : assetFailureSets-failureChainResolutions-item-response
Type:
Show Source
object-
ActiveEndDate: string
(date-time)
Read Only:
true -
CauseCodeId: integer
(int64)
Read Only:
true -
FailureCodeId: integer
Read Only:
true -
FailureSetId: integer
(int64)
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ResolutionCode: string
Read Only:
trueMaximum Length:30 -
ResolutionCodeId: number
Read Only:
true -
ResolutionDescription: string
Read Only:
trueMaximum Length:540 -
ResolutionName: string
Read Only:
trueMaximum Length:240
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : assetFailureSets-failureChains-item-response
Type:
Show Source
object-
ActiveEndDate: string
(date-time)
Title:
Active End DateRead Only:true -
CauseCategoryCode: string
Title:
Cause Category CodeRead Only:trueMaximum Length:255 -
CauseCategoryName: string
Title:
Cause Category NameRead Only:trueMaximum Length:255 -
CauseCode: string
Title:
Cause CodeMaximum Length:30 -
CauseCodeId: integer
(int64)
Title:
Cause Code ID -
CauseDescription: string
Title:
Cause DescriptionRead Only:trueMaximum Length:255 -
CauseName: string
Title:
Cause NameRead Only:trueMaximum Length:255 -
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
FailureCategoryCode: string
Title:
Failure Category CodeRead Only:trueMaximum Length:255 -
FailureCategoryName: string
Title:
Failure Category NameRead Only:trueMaximum Length:255 -
FailureChainDisableFlag: boolean
Title:
Disable -
FailureChainId: integer
(int64)
Title:
Failure Chain IDRead Only:true -
FailureCode: string
Title:
Failure CodeMaximum Length:30 -
FailureCodeId: integer
(int64)
Title:
Failure Code -
FailureDescription: string
Title:
Failure DescriptionRead Only:trueMaximum Length:255 -
FailureName: string
Title:
Failure NameRead Only:trueMaximum Length:255 -
FailureSetId: integer
(int64)
Title:
Failure Set ID -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ResolutionCategoryCode: string
Title:
Resolution Category CodeRead Only:trueMaximum Length:255 -
ResolutionCategoryName: string
Title:
Resolution Category NameRead Only:trueMaximum Length:255 -
ResolutionCode: string
Title:
Resolution CodeMaximum Length:30 -
ResolutionCodeId: number
Title:
Resolution Code ID -
ResolutionDescription: string
Title:
Resolution DescriptionRead Only:trueMaximum Length:255 -
ResolutionName: string
Title:
Resolution NameRead Only:trueMaximum Length:255
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- failureAssociations
-
Operation: /fscmRestApi/resources/11.13.18.05/assetFailureSets/{FailureSetId}/child/failureAssociationsParameters:
- FailureSetId:
$request.path.FailureSetId
- FailureSetId:
- failureChainCauses
-
Operation: /fscmRestApi/resources/11.13.18.05/assetFailureSets/{FailureSetId}/child/failureChainCausesParameters:
- FailureSetId:
$request.path.FailureSetId
- FailureSetId:
- failureChainFailures
-
Operation: /fscmRestApi/resources/11.13.18.05/assetFailureSets/{FailureSetId}/child/failureChainFailuresParameters:
- FailureSetId:
$request.path.FailureSetId
- FailureSetId:
- failureChainResolutions
-
Operation: /fscmRestApi/resources/11.13.18.05/assetFailureSets/{FailureSetId}/child/failureChainResolutionsParameters:
- FailureSetId:
$request.path.FailureSetId
- FailureSetId:
- failureChains
-
Parameters:
- FailureSetId:
$request.path.FailureSetId
- FailureSetId:
Examples
Examples
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/versionassetFailureSets/FailureSetId"
For example:
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/assetFailureSets/300100549533800"
Example 1 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.
"{
"FailureChainsEnforcedFlag":true
}"Example 1 Response Body
The following example includes the contents of the response
body in JSON format:
"{
"FailureSetId": 300100549533800,
"FailureSetCode": "FS7",
"FailureSetName": "FS7",
"ActiveEndDate": null,
"FailureChainsEnforcedFlag": true,
"FailureSetDescription": "FS7",
"FailureSetDisableFlag": null
}"Example 2 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.
"{
"FailureSetDisableFlag": true
}"Example 2 Response Body
The following example includes the contents of the response body in JSON
format:
"{
"FailureSetId": 300100549533800,
"FailureSetCode": "FS7",
"FailureSetName": "FS7",
"ActiveEndDate": "2021-11-19T16:32:57.196+00:00",
"FailureChainsEnforcedFlag": true,
"FailureSetDescription": "FS7",
"FailureSetDisableFlag": true
}"