Odoo 19 Developer Reference

https://www.odoo.com/documentation/19.0/developer/reference.html
Admin
Odoo 19 Developer Reference is comprehensive documentation covering server and web frameworks, ORM...
Tokens:2,190
Snippets:11
Trust Score:10
Update:13 hours ago
Show doc for...
Tokens:
Raw
### External RPC API - Create records

Source: https://www.odoo.com/documentation/19.0/developer/reference.html

Create new records.

```APIDOC
## Create records

### Description
Create new records.

### Method
create

### Endpoint
xmlrpc/2/object

### Parameters
#### Request Body
- **db** (string) - Required - The name of the database.
- **uid** (integer) - Required - The user ID.
- **password** (string) - Required - The password.
- **model** (string) - Required - The model name.
- **method** (string) - Required - The method to call (create).
- **args** (array) - Required - The positional arguments.
- **kwargs** (object) - Optional - The keyword arguments.

### Response
#### Success Response
- **result** (integer) - The ID of the created record.

#### Response Example
{
  "result": 10
}
```

--------------------------------

### External RPC API - Logging in

Source: https://www.odoo.com/documentation/19.0/developer/reference.html

Authenticate a user and obtain a user ID for subsequent API calls.

```APIDOC
## Logging in

### Description
Authenticate a user and obtain a user ID for subsequent API calls.

### Method
authenticate

### Endpoint
xmlrpc/2/common

### Parameters
#### Request Body
- **db** (string) - Required - The name of the database.
- **login** (string) - Required - The username.
- **password** (string) - Required - The password.

### Response
#### Success Response
- **uid** (integer) - The user ID of the authenticated user.

#### Response Example
{
  "uid": 1
}
```

--------------------------------

### External RPC API - List record fields

Source: https://www.odoo.com/documentation/19.0/developer/reference.html

List the fields of a model.

```APIDOC
## List record fields

### Description
List the fields of a model.

### Method
fields_get

### Endpoint
xmlrpc/2/object

### Parameters
#### Request Body
- **db** (string) - Required - The name of the database.
- **uid** (integer) - Required - The user ID.
- **password** (string) - Required - The password.
- **model** (string) - Required - The model name.
- **method** (string) - Required - The method to call (fields_get).
- **args** (array) - Required - The positional arguments.
- **kwargs** (object) - Optional - The keyword arguments.

### Response
#### Success Response
- **result** (object) - The fields of the model.

#### Response Example
{
  "result": {
    "name": {
      "type": "char",
      "string": "Name"
    }
  }
}
```

--------------------------------

### External RPC API - Search and read

Source: https://www.odoo.com/documentation/19.0/developer/reference.html

Search and read records in one call.

```APIDOC
## Search and read

### Description
Search and read records in one call.

### Method
search_read

### Endpoint
xmlrpc/2/object

### Parameters
#### Request Body
- **db** (string) - Required - The name of the database.
- **uid** (integer) - Required - The user ID.
- **password** (string) - Required - The password.
- **model** (string) - Required - The model name.
- **method** (string) - Required - The method to call (search_read).
- **args** (array) - Required - The positional arguments.
- **kwargs** (object) - Optional - The keyword arguments.

### Response
#### Success Response
- **result** (array) - The list of records.

#### Response Example
{
  "result": [
    {
      "id": 1,
      "name": "Record 1"
    }
  ]
}
```

--------------------------------

### External RPC API - Connection

Source: https://www.odoo.com/documentation/19.0/developer/reference.html

Describes how to establish a connection to the Odoo server using the External RPC API.

```APIDOC
## Connection

### Description
Establish a connection to the Odoo server.

### Method
connect

### Endpoint
xmlrpc/2/common

### Parameters
#### Request Body
- **url** (string) - Required - The URL of the Odoo server.
- **database** (string) - Required - The name of the database.
- **username** (string) - Required - The username for authentication.
- **password** (string) - Required - The password for authentication.

### Response
#### Success Response
- **uid** (integer) - The user ID of the authenticated user.

#### Response Example
{
  "uid": 1
}
```

--------------------------------

### External RPC API - List records

Source: https://www.odoo.com/documentation/19.0/developer/reference.html

List records of a model.

```APIDOC
## List records

### Description
List records of a model.

### Method
search_read

### Endpoint
xmlrpc/2/object

### Parameters
#### Request Body
- **db** (string) - Required - The name of the database.
- **uid** (integer) - Required - The user ID.
- **password** (string) - Required - The password.
- **model** (string) - Required - The model name.
- **method** (string) - Required - The method to call (search_read).
- **args** (array) - Required - The positional arguments.
- **kwargs** (object) - Optional - The keyword arguments.

### Response
#### Success Response
- **result** (array) - The list of records.

#### Response Example
{
  "result": [
    {
      "id": 1,
      "name": "Record 1"
    }
  ]
}
```

--------------------------------

### External RPC API - Calling methods

Source: https://www.odoo.com/documentation/19.0/developer/reference.html

Call methods on Odoo models using the execute_kw method.

```APIDOC
## Calling methods

### Description
Call methods on Odoo models using the execute_kw method.

### Method
execute_kw

### Endpoint
xmlrpc/2/object

### Parameters
#### Request Body
- **db** (string) - Required - The name of the database.
- **uid** (integer) - Required - The user ID.
- **password** (string) - Required - The password.
- **model** (string) - Required - The model name.
- **method** (string) - Required - The method to call.
- **args** (array) - Required - The positional arguments.
- **kwargs** (object) - Optional - The keyword arguments.

### Response
#### Success Response
- **result** (any) - The result of the method call.

#### Response Example
{
  "result": true
}
```

--------------------------------

### External RPC API - Count records

Source: https://www.odoo.com/documentation/19.0/developer/reference.html

Count the number of records matching a domain.

```APIDOC
## Count records

### Description
Count the number of records matching a domain.

### Method
search_count

### Endpoint
xmlrpc/2/object

### Parameters
#### Request Body
- **db** (string) - Required - The name of the database.
- **uid** (integer) - Required - The user ID.
- **password** (string) - Required - The password.
- **model** (string) - Required - The model name.
- **method** (string) - Required - The method to call (search_count).
- **args** (array) - Required - The positional arguments.
- **kwargs** (object) - Optional - The keyword arguments.

### Response
#### Success Response
- **result** (integer) - The number of records.

#### Response Example
{
  "result": 5
}
```

--------------------------------

### External RPC API - Read records

Source: https://www.odoo.com/documentation/19.0/developer/reference.html

Read records by their IDs.

```APIDOC
## Read records

### Description
Read records by their IDs.

### Method
read

### Endpoint
xmlrpc/2/object

### Parameters
#### Request Body
- **db** (string) - Required - The name of the database.
- **uid** (integer) - Required - The user ID.
- **password** (string) - Required - The password.
- **model** (string) - Required - The model name.
- **method** (string) - Required - The method to call (read).
- **args** (array) - Required - The positional arguments.
- **kwargs** (object) - Optional - The keyword arguments.

### Response
#### Success Response
- **result** (array) - The list of records.

#### Response Example
{
  "result": [
    {
      "id": 1,
      "name": "Record 1"
    }
  ]
}
```

--------------------------------

### External RPC API - Update records

Source: https://www.odoo.com/documentation/19.0/developer/reference.html

Update existing records.

```APIDOC
## Update records

### Description
Update existing records.

### Method
write

### Endpoint
xmlrpc/2/object

### Parameters
#### Request Body
- **db** (string) - Required - The name of the database.
- **uid** (integer) - Required - The user ID.
- **password** (string) - Required - The password.
- **model** (string) - Required - The model name.
- **method** (string) - Required - The method to call (write).
- **args** (array) - Required - The positional arguments.
- **kwargs** (object) - Optional - The keyword arguments.

### Response
#### Success Response
- **result** (boolean) - True if the update was successful.

#### Response Example
{
  "result": true
}
```

--------------------------------

### External RPC API - Delete records

Source: https://www.odoo.com/documentation/19.0/developer/reference.html

Delete existing records.

```APIDOC
## Delete records

### Description
Delete existing records.

### Method
unlink

### Endpoint
xmlrpc/2/object

### Parameters
#### Request Body
- **db** (string) - Required - The name of the database.
- **uid** (integer) - Required - The user ID.
- **password** (string) - Required - The password.
- **model** (string) - Required - The model name.
- **method** (string) - Required - The method to call (unlink).
- **args** (array) - Required - The positional arguments.
- **kwargs** (object) - Optional - The keyword arguments.

### Response
#### Success Response
- **result** (boolean) - True if the deletion was successful.

#### Response Example
{
  "result": true
}
```
Tokens:
Raw