Jump to

• Request
• Response

Update a Vehicle Optional

patch

/crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleOptionals/{OptionalNumber}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• OptionalNumber: string
  Identifier to Vehicle Options
• VehicleIdentificationNumber: string
  Identifier to Vehicles

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : autoVehicles-VehicleOptionals-item

Type: object

Show Source

• AttributeCategory(optional): string
  Title: Attribute Category

  Maximum Length: 30

  A system-generated read-only attribute used by the application framework.
• CorpCurrencyCode(optional): string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the record.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the record was created.
• CurcyConvRateType(optional): string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the record.
• CurrencyCode(optional): string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the record like USD or EUR.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the record was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin(optional): string
  Title: Last Update Login

  Maximum Length: 32

  The login of the user who last updated the record.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  Title: Object Version Number

  A system-generated read-only attribute used by the application framework.
• OptionalCode(optional): string
  Title: Code

  Maximum Length: 400

  The code associated with the option.
• OptionalDescription(optional): string
  Title: Description

  Maximum Length: 4000

  The description of the option.
• OptionalId(optional): integer(int64)
  Title: Optional ID

  The unique identifier of the option.
• OptionalName(optional): string
  Title: Name

  Maximum Length: 400

  The name of the option.
• OptionalNumber(optional): string
  Title: Optional

  Maximum Length: 30

  The public unique identifier of the record.
• OrgId(optional): integer(int64)
  Title: Business Unit

  The business unit associated with the record.
• OriginSystem(optional): string
  Title: Origin System

  Maximum Length: 400

  The application from where the order originated.
• OriginSystemReference(optional): string
  Title: Origin System Reference

  Maximum Length: 400

  The unique identifier of the record in the source application.
• VehicleId(optional): integer(int64)
  Title: Vehicle ID

  The unique identifier of the vehicle.

{
    "properties":{
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Attribute Category"
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the record.",
            "title":"Corporate Currency Code"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was created.",
            "title":"Creation Date"
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the record.",
            "title":"Conversion Rate Type"
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the record like USD or EUR.",
            "title":"Currency Code"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "title":"Last Update Login"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "title":"Last Updated By"
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Object Version Number"
        },
        "OptionalCode":{
            "maxLength":400,
            "type":"string",
            "description":"The code associated with the option.",
            "title":"Code"
        },
        "OptionalDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"The description of the option.",
            "title":"Description"
        },
        "OptionalId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the option.",
            "title":"Optional ID"
        },
        "OptionalName":{
            "maxLength":400,
            "type":"string",
            "description":"The name of the option.",
            "title":"Name"
        },
        "OptionalNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the record.",
            "title":"Optional"
        },
        "OrgId":{
            "format":"int64",
            "type":"integer",
            "description":"The business unit associated with the record.",
            "title":"Business Unit"
        },
        "OriginSystem":{
            "maxLength":400,
            "type":"string",
            "description":"The application from where the order originated.",
            "title":"Origin System"
        },
        "OriginSystemReference":{
            "maxLength":400,
            "type":"string",
            "description":"The unique identifier of the record in the source application.",
            "title":"Origin System Reference"
        },
        "VehicleId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the vehicle.",
            "title":"Vehicle ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : autoVehicles-VehicleOptionals-item

Type: object

Show Source

• AttributeCategory(optional): string
  Title: Attribute Category

  Maximum Length: 30

  A system-generated read-only attribute used by the application framework.
• CorpCurrencyCode(optional): string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the record.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the record was created.
• CurcyConvRateType(optional): string
  Title: Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the record.
• CurrencyCode(optional): string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the record like USD or EUR.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the record was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin(optional): string
  Title: Last Update Login

  Maximum Length: 32

  The login of the user who last updated the record.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  Title: Object Version Number

  A system-generated read-only attribute used by the application framework.
• OptionalCode(optional): string
  Title: Code

  Maximum Length: 400

  The code associated with the option.
• OptionalDescription(optional): string
  Title: Description

  Maximum Length: 4000

  The description of the option.
• OptionalId(optional): integer(int64)
  Title: Optional ID

  The unique identifier of the option.
• OptionalName(optional): string
  Title: Name

  Maximum Length: 400

  The name of the option.
• OptionalNumber(optional): string
  Title: Optional

  Maximum Length: 30

  The public unique identifier of the record.
• OrgId(optional): integer(int64)
  Title: Business Unit

  The business unit associated with the record.
• OriginSystem(optional): string
  Title: Origin System

  Maximum Length: 400

  The application from where the order originated.
• OriginSystemReference(optional): string
  Title: Origin System Reference

  Maximum Length: 400

  The unique identifier of the record in the source application.
• VehicleId(optional): integer(int64)
  Title: Vehicle ID

  The unique identifier of the vehicle.

{
    "properties":{
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Attribute Category"
        },
        "CorpCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the record.",
            "title":"Corporate Currency Code"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was created.",
            "title":"Creation Date"
        },
        "CurcyConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type associated with the record.",
            "title":"Conversion Rate Type"
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the record like USD or EUR.",
            "title":"Currency Code"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "title":"Last Update Login"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "title":"Last Updated By"
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Object Version Number"
        },
        "OptionalCode":{
            "maxLength":400,
            "type":"string",
            "description":"The code associated with the option.",
            "title":"Code"
        },
        "OptionalDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"The description of the option.",
            "title":"Description"
        },
        "OptionalId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the option.",
            "title":"Optional ID"
        },
        "OptionalName":{
            "maxLength":400,
            "type":"string",
            "description":"The name of the option.",
            "title":"Name"
        },
        "OptionalNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the record.",
            "title":"Optional"
        },
        "OrgId":{
            "format":"int64",
            "type":"integer",
            "description":"The business unit associated with the record.",
            "title":"Business Unit"
        },
        "OriginSystem":{
            "maxLength":400,
            "type":"string",
            "description":"The application from where the order originated.",
            "title":"Origin System"
        },
        "OriginSystemReference":{
            "maxLength":400,
            "type":"string",
            "description":"The unique identifier of the record in the source application.",
            "title":"Origin System Reference"
        },
        "VehicleId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the vehicle.",
            "title":"Vehicle ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top