Jump to

• Request
• Response
• Examples

Update one list

patch

/fscmRestApi/resources/11.13.18.05/maintenanceAssets/{AssetId}/child/PartsListComponent/{ListComponentId}

Request

Path Parameters

• AssetId(required): integer(int64)
  Value that uniquely identifies the asset charge. The application creates this value when it creates the asset charge. This attribute is read-only.
• ListComponentId(required): integer(int64)
  Value that uniquely identifies the parts list item that the asset references.

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

• AssetId: integer
  Value that uniquely identifies the asset for each component. You can create only one relationship between each value that attribute ListComponentId specifies and that AssetId specifies.
• ComponentQuantity: number
  Title: Quantity

  Quality of each part list component for the asset. This attribute is optional when creating a part list component for the asset.
• ItemId: integer (int64)
  Value that uniquely identifies the item that is part of the part list for the asset. Asset Item cannot be part of the part list for the same asset.
• ItemOrganizationId: integer (int64)
  Value that uniquely identifies the organization that creates or uses the asset. The itemOrganizationId for the asset and for the parts list component use the same value.
• ListComponentId: integer (int64)
  Value that uniquely identifies the parts list item that the asset references.

{
    "type":"object",
    "properties":{
        "ItemOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that creates or uses the asset. The itemOrganizationId for the asset and for the parts list component use the same value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ListComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parts list item that the asset references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ComponentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quality of each part list component for the asset. This attribute is optional when creating a part list component for the asset.",
            "nullable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset for each component. You can create only one relationship between each value that attribute ListComponentId specifies and that AssetId specifies.",
            "nullable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that is part of the part list for the asset. Asset Item cannot be part of the part list for the same asset.",
            "format":"int64",
            "nullable":false,
            "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 : maintenanceAssets-PartsListComponent-item-response

Type: object

Show Source

• AssetId: integer
  Value that uniquely identifies the asset for each component. You can create only one relationship between each value that attribute ListComponentId specifies and that AssetId specifies.
• ComponentQuantity: number
  Title: Quantity

  Quality of each part list component for the asset. This attribute is optional when creating a part list component for the asset.
• ItemId: integer (int64)
  Value that uniquely identifies the item that is part of the part list for the asset. Asset Item cannot be part of the part list for the same asset.
• ItemOrganizationId: integer (int64)
  Value that uniquely identifies the organization that creates or uses the asset. The itemOrganizationId for the asset and for the parts list component use the same value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListComponentId: integer (int64)
  Value that uniquely identifies the parts list item that the asset references.

{
    "type":"object",
    "properties":{
        "ItemOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization that creates or uses the asset. The itemOrganizationId for the asset and for the parts list component use the same value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ListComponentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parts list item that the asset references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ComponentQuantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quality of each part list component for the asset. This attribute is optional when creating a part list component for the asset.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset for each component. You can create only one relationship between each value that attribute ListComponentId specifies and that AssetId specifies.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that is part of the part list for the asset. Asset Item cannot be part of the part list for the same asset.",
            "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 parts list in one maintenance 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/maintenanceAssets/AssetId/child/PartsListComponent/ListComponentId"

For example, the following command updates parts list 300100113400236 in maintenance asset 100100053525029:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/maintenanceAssets/100100053525029/child/PartsListComponent/300100113400236

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.

{
"ComponentQuantity":10
}

Example Response Body

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

{
  "AssetId" : 100100053525029,
  "ComponentQuantity" : 10,
  "ItemId" : 300100013645875,
  "ItemOrganizationId" : 207,
  "ListComponentId" : 300100113400236
}

Back to Top