Jump to

• Request
• Response

Update a Vehicle Ownership

patch

/crmRestApi/resources/11.13.18.05/autoVehicles/{VehicleIdentificationNumber}/child/VehicleOwnerships/{OwnershipNumber}

Request

Supported Media Types

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

Path Parameters

• OwnershipNumber: string
  Identifier to Vehicle Owners
• VehicleIdentificationNumber: string
  Identifier to Vehicles

Body ()

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

Root Schema : autoVehicles-VehicleOwnerships-item

Type: object

Show Source

• AssetId(optional): integer(int64)
  Title: Asset ID

  The unique identifier of the asset.
• AttributeCategory(optional): string
  Title: Attribute Category

  Maximum Length: 30

  A system-generated read-only attribute used by the application framework.
• AverageAnnualMileage(optional): number
  Title: Average Annual Mileage

  The average annual mileage of the vehicle.
• 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.
• IsPrimary(optional): string
  Title: Primary

  Maximum Length: 1

  The primary owner of the vehicle.
• 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.
• OdometerReadingDate(optional): string(date)
  Title: Odometer Reading Date

  The date when the odometer reading was taken.
• OrgId(optional): integer(int64)
  Title: Business Unit

  The unique identifier of the business unit.
• 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.
• OwnershipEndDate(optional): string(date)
  Title: End Date

  The date when the ownership ends.
• OwnershipEndReason(optional): string
  Title: Reason

  Maximum Length: 4000

  The ownership end reason.
• OwnershipId(optional): integer(int64)
  Title: Ownership ID

  The unique identifier of the ownership.
• OwnershipNumber(optional): string
  Maximum Length: 30

  The public unique identifier of the record.
• OwnershipStartDate(optional): string(date)
  Title: Start Date

  The date when the ownership started.
• VehicleId(optional): integer(int64)
  Title: Vehicle ID

  The unique identifier of the vehicle.
• VehicleOwnerId(optional): integer(int64)
  Title: Owner ID

  The unique identifier of the owner associated with the vehicle.

{
    "properties":{
        "AssetId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "title":"Asset ID"
        },
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Attribute Category"
        },
        "AverageAnnualMileage":{
            "type":"number",
            "description":"The average annual mileage of the vehicle.",
            "title":"Average Annual Mileage"
        },
        "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"
        },
        "IsPrimary":{
            "maxLength":1,
            "type":"string",
            "description":"The primary owner of the vehicle.",
            "title":"Primary"
        },
        "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"
        },
        "OdometerReadingDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the odometer reading was taken.",
            "title":"Odometer Reading Date"
        },
        "OrgId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "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"
        },
        "OwnershipEndDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the ownership ends.",
            "title":"End Date"
        },
        "OwnershipEndReason":{
            "maxLength":4000,
            "type":"string",
            "description":"The ownership end reason.",
            "title":"Reason"
        },
        "OwnershipId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the ownership.",
            "title":"Ownership ID"
        },
        "OwnershipNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the record."
        },
        "OwnershipStartDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the ownership started.",
            "title":"Start Date"
        },
        "VehicleId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the vehicle.",
            "title":"Vehicle ID"
        },
        "VehicleOwnerId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the owner associated with the vehicle.",
            "title":"Owner ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "x-links":[
        {
            "rel":"lov",
            "title":"IsPrimary LOV",
            "description":"<p>The following properties are defined on the LOV link relation:</p><ul><li>Source Attribute: IsPrimary; Target Attribute: LookupCode</li><li>Display Attribute: Meaning</li></ul>",
            "method":"get",
            "href":"/crmRestApi/resources/11.13.18.05/fndStaticLookups",
            "mediaType":"application/vnd.oracle.adf.resourcecollection+json",
            "targetSchema":{
                "properties":{
                    "LookupCode":{
                        "type":"string",
                        "description":"The unique code for the lookup."
                    },
                    "Meaning":{
                        "type":"string",
                        "description":"The display value for the lookup in the application."
                    }
                },
                "type":"object"
            },
            "schema":{
                "properties":{
                    "limit":{
                        "type":"integer",
                        "description":"This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources."
                    },
                    "offset":{
                        "type":"integer",
                        "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0."
                    },
                    "totalResults":{
                        "type":"boolean",
                        "description":"The resource collection representation will include the \"estimated row count\" when \"?totalResults=true\", otherwise the count is not included.  The default value is \"false\"."
                    },
                    "onlyData":{
                        "type":"boolean",
                        "description":"The resource item payload will be filtered in order to contain only data (no links section, for example)."
                    },
                    "dependency":{
                        "type":"string",
                        "description":"This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes.  Example: dependency=ProductId=2<br><br>Format: &lt;attr1&gt;=&lt;val1&gt;,&lt;attr2&gt;=&lt;value2&gt;"
                    },
                    "orderBy":{
                        "type":"string",
                        "description":"This parameter orders a resource collection based on the specified attributes.  The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and \"asc\" or \"desc\".  Specify \"asc\" for ascending and \"desc\" for descending. The default value is \"asc\".  For example, ?orderBy=field1:asc,field2:desc"
                    },
                    "links":{
                        "items":{
                            "$ref":"#/definitions/link"
                        },
                        "type":"array",
                        "description":"The link relations associated with the resource instance."
                    },
                    "finder":{
                        "default":"LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO",
                        "type":"string",
                        "description":"Used as a predefined finder to search the collection.<br><br>Format: ?finder=&lt;finderName&gt;;&lt;variableName&gt;=&lt;variableValue&gt;,&lt;variableName2&gt;=&lt;variableValue2&gt;<br><br>Default finder: LookupTypeIsActiveEnabledFinder"
                    }
                },
                "type":"object"
            },
            "effectiveMethod":"get"
        }
    ],
    "type":"object"
}

Relationships

IsPrimary LOV

Method: get

Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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-VehicleOwnerships-item

Type: object

Show Source

• AssetId(optional): integer(int64)
  Title: Asset ID

  The unique identifier of the asset.
• AttributeCategory(optional): string
  Title: Attribute Category

  Maximum Length: 30

  A system-generated read-only attribute used by the application framework.
• AverageAnnualMileage(optional): number
  Title: Average Annual Mileage

  The average annual mileage of the vehicle.
• 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.
• IsPrimary(optional): string
  Title: Primary

  Maximum Length: 1

  The primary owner of the vehicle.
• 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.
• OdometerReadingDate(optional): string(date)
  Title: Odometer Reading Date

  The date when the odometer reading was taken.
• OrgId(optional): integer(int64)
  Title: Business Unit

  The unique identifier of the business unit.
• 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.
• OwnershipEndDate(optional): string(date)
  Title: End Date

  The date when the ownership ends.
• OwnershipEndReason(optional): string
  Title: Reason

  Maximum Length: 4000

  The ownership end reason.
• OwnershipId(optional): integer(int64)
  Title: Ownership ID

  The unique identifier of the ownership.
• OwnershipNumber(optional): string
  Maximum Length: 30

  The public unique identifier of the record.
• OwnershipStartDate(optional): string(date)
  Title: Start Date

  The date when the ownership started.
• VehicleId(optional): integer(int64)
  Title: Vehicle ID

  The unique identifier of the vehicle.
• VehicleOwnerId(optional): integer(int64)
  Title: Owner ID

  The unique identifier of the owner associated with the vehicle.

{
    "properties":{
        "AssetId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the asset.",
            "title":"Asset ID"
        },
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"A system-generated read-only attribute used by the application framework.",
            "title":"Attribute Category"
        },
        "AverageAnnualMileage":{
            "type":"number",
            "description":"The average annual mileage of the vehicle.",
            "title":"Average Annual Mileage"
        },
        "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"
        },
        "IsPrimary":{
            "maxLength":1,
            "type":"string",
            "description":"The primary owner of the vehicle.",
            "title":"Primary"
        },
        "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"
        },
        "OdometerReadingDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the odometer reading was taken.",
            "title":"Odometer Reading Date"
        },
        "OrgId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "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"
        },
        "OwnershipEndDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the ownership ends.",
            "title":"End Date"
        },
        "OwnershipEndReason":{
            "maxLength":4000,
            "type":"string",
            "description":"The ownership end reason.",
            "title":"Reason"
        },
        "OwnershipId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the ownership.",
            "title":"Ownership ID"
        },
        "OwnershipNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the record."
        },
        "OwnershipStartDate":{
            "format":"date",
            "type":"string",
            "description":"The date when the ownership started.",
            "title":"Start Date"
        },
        "VehicleId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the vehicle.",
            "title":"Vehicle ID"
        },
        "VehicleOwnerId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the owner associated with the vehicle.",
            "title":"Owner ID"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "x-links":[
        {
            "rel":"lov",
            "title":"IsPrimary LOV",
            "description":"<p>The following properties are defined on the LOV link relation:</p><ul><li>Source Attribute: IsPrimary; Target Attribute: LookupCode</li><li>Display Attribute: Meaning</li></ul>",
            "method":"get",
            "href":"/crmRestApi/resources/11.13.18.05/fndStaticLookups",
            "mediaType":"application/vnd.oracle.adf.resourcecollection+json",
            "targetSchema":{
                "properties":{
                    "LookupCode":{
                        "type":"string",
                        "description":"The unique code for the lookup."
                    },
                    "Meaning":{
                        "type":"string",
                        "description":"The display value for the lookup in the application."
                    }
                },
                "type":"object"
            },
            "schema":{
                "properties":{
                    "limit":{
                        "type":"integer",
                        "description":"This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources."
                    },
                    "offset":{
                        "type":"integer",
                        "description":"Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0."
                    },
                    "totalResults":{
                        "type":"boolean",
                        "description":"The resource collection representation will include the \"estimated row count\" when \"?totalResults=true\", otherwise the count is not included.  The default value is \"false\"."
                    },
                    "onlyData":{
                        "type":"boolean",
                        "description":"The resource item payload will be filtered in order to contain only data (no links section, for example)."
                    },
                    "dependency":{
                        "type":"string",
                        "description":"This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes.  Example: dependency=ProductId=2<br><br>Format: &lt;attr1&gt;=&lt;val1&gt;,&lt;attr2&gt;=&lt;value2&gt;"
                    },
                    "orderBy":{
                        "type":"string",
                        "description":"This parameter orders a resource collection based on the specified attributes.  The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and \"asc\" or \"desc\".  Specify \"asc\" for ascending and \"desc\" for descending. The default value is \"asc\".  For example, ?orderBy=field1:asc,field2:desc"
                    },
                    "links":{
                        "items":{
                            "$ref":"#/definitions/link"
                        },
                        "type":"array",
                        "description":"The link relations associated with the resource instance."
                    },
                    "finder":{
                        "default":"LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO",
                        "type":"string",
                        "description":"Used as a predefined finder to search the collection.<br><br>Format: ?finder=&lt;finderName&gt;;&lt;variableName&gt;=&lt;variableValue&gt;,&lt;variableName2&gt;=&lt;variableValue2&gt;<br><br>Default finder: LookupTypeIsActiveEnabledFinder"
                    }
                },
                "type":"object"
            },
            "effectiveMethod":"get"
        }
    ],
    "type":"object"
}

Relationships

IsPrimary LOV

Method: get

Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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