Jump to

• Request
• Response
• Examples

Update

patch

/fscmRestApi/resources/11.13.18.05/assetConditionEventCodes/{ConditionEventCodeId}

Request

Path Parameters

• ConditionEventCodeId(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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Title: Active End Date
• ConditionEventCategoryCode: string
  Title: Category Code

  Maximum Length: 30
• ConditionEventCode: string
  Title: Condition Event Code

  Maximum Length: 30
• ConditionEventCodeDisableFlag: boolean
  Title: Disable Condition Event Code
• ConditionEventDescription: string
  Title: Condition Event Description

  Maximum Length: 540
• ConditionEventName: string
  Title: Condition Event Name

  Maximum Length: 540
• ConditionEventTypeCode: string
  Title: Condition Event Type Code

  Maximum Length: 30
• SourceReferenceId: string
  Title: Source Reference ID

  Maximum Length: 36

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "format":"date-time",
            "nullable":true
        },
        "ConditionEventCategoryCode":{
            "title":"Category Code",
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "ConditionEventCode":{
            "title":"Condition Event Code",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "ConditionEventCodeDisableFlag":{
            "title":"Disable Condition Event Code",
            "type":"boolean",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ConditionEventDescription":{
            "title":"Condition Event Description",
            "maxLength":540,
            "type":"string",
            "nullable":true
        },
        "ConditionEventName":{
            "title":"Condition Event Name",
            "maxLength":540,
            "type":"string",
            "nullable":true
        },
        "ConditionEventTypeCode":{
            "title":"Condition Event Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false
        },
        "SourceReferenceId":{
            "title":"Source Reference ID",
            "maxLength":36,
            "type":"string",
            "nullable":true
        }
    }
}

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 : assetConditionEventCodes-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Title: Active End Date
• ConditionEventCategoryCode: string
  Title: Category Code

  Maximum Length: 30
• ConditionEventCategoryName: string
  Title: Condition Event Category Name
• ConditionEventCode: string
  Title: Condition Event Code

  Maximum Length: 30
• ConditionEventCodeDisableFlag: boolean
  Title: Disable Condition Event Code
• ConditionEventCodeId: integer (int64)
  Title: Condition Event Code ID

  Read Only: true
• ConditionEventDescription: string
  Title: Condition Event Description

  Maximum Length: 540
• ConditionEventName: string
  Title: Condition Event Name

  Maximum Length: 540
• ConditionEventTypeCode: string
  Title: Condition Event Type Code

  Maximum Length: 30
• ConditionEventTypeName: string
  Title: Condition Event Type Name
• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceReferenceId: string
  Title: Source Reference ID

  Maximum Length: 36

{
    "type":"object",
    "properties":{
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionEventCategoryCode":{
            "title":"Category Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionEventCategoryName":{
            "title":"Condition Event Category Name",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionEventCode":{
            "title":"Condition Event Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "ConditionEventCodeDisableFlag":{
            "title":"Disable Condition Event Code",
            "type":"boolean",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ConditionEventCodeId":{
            "title":"Condition Event Code ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ConditionEventDescription":{
            "title":"Condition Event Description",
            "maxLength":540,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionEventName":{
            "title":"Condition Event Name",
            "maxLength":540,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionEventTypeCode":{
            "title":"Condition Event Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "ConditionEventTypeName":{
            "title":"Condition Event Type Name",
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceReferenceId":{
            "title":"Source Reference ID",
            "maxLength":36,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 condition event code.

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/assetConditionEventCodes/ConditionEventCodeId"

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/assetConditionEventCodes/300100549946529"

Example 1 Request Body

The following example includes the contents of the request body in JSON format.

"{
"ConditionEventName":"UPDATE1",
"ConditionEventDescription":"Updated Description",
"SourceReferenceId":"SourceRefID-1001"
}"

Example 1 Response Body

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

"{
    "ConditionEventCodeId": 300100549946529,
    "ConditionEventCode": "FC-1",
    "ConditionEventName": "UPDATE1",
    "ConditionEventDescription": "Updated Description",
    "ConditionEventTypeCode": "FAILURE",
    "ConditionEventTypeName": "Failure code",
    "ConditionEventCategoryCode": null,
    "ConditionEventCategoryName": null,
    "SourceReferenceId": "SourceRefID-1001",
    "ActiveEndDate": null,
    "ConditionEventCodeDisableFlag": null,
    "CreatedBy": "MNT_QA",
    "CreationDate": "2021-11-19T13:34:58+00:00",
    "LastUpdateDate": "2021-11-19T13:39:10+00:00",
    "LastUpdateLogin": "D0F94746327E418FE053AF01F40A62ED",
    "LastUpdatedBy": "MNT_QA"
}"

Example 2 Request Body

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

"{
    "ConditionEventCodeDisableFlag":"Y"
}"

Example 2 Response Body

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

"{
    "ConditionEventCodeId": 300100549946529,
    "ConditionEventCode": "FC-1",
    "ConditionEventName": "UPDATE1",
    "ConditionEventDescription": "Updated Description",
    "ConditionEventTypeCode": "FAILURE",
    "ConditionEventTypeName": "Failure code",
    "ConditionEventCategoryCode": null,
    "ConditionEventCategoryName": null,
    "SourceReferenceId": "SourceRefID-1001",
    "ActiveEndDate": "2021-11-19T13:42:13.708+00:00",
    "ConditionEventCodeDisableFlag": true,
    "CreatedBy": "MNT_QA",
    "CreationDate": "2021-11-19T13:34:58+00:00",
    "LastUpdateDate": "2021-11-19T13:42:13+00:00",
    "LastUpdateLogin": "D1130B5D0CAF5073E053AF01F40A49BE",
    "LastUpdatedBy": "MNT_QA" 
}"

Back to Top