Skip to main content
PUT
/
v1
/
worksites
/
{id}
/
operations
/
{worksite_operation_id}
Worksite operation update
curl --request PUT \
  --url https://api.opx.co/partners/v1/worksites/{id}/operations/{worksite_operation_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "kwhc": 123,
  "cee_amount": 123,
  "aides_informations": [
    "<string>"
  ],
  "external_reference": "<string>",
  "cdp_amount": 123,
  "mpr_amount": 123,
  "fost_version": "<string>",
  "ah_informations": [
    "<string>"
  ],
  "commitment_date": "<string>",
  "invoice_reference": "<string>",
  "material_ids": [
    "<string>"
  ],
  "completion_proof_date": "<string>",
  "subcontractor_id": 123,
  "quote_reference": "<string>",
  "custom_status_id": 123
}
'
import requests

url = "https://api.opx.co/partners/v1/worksites/{id}/operations/{worksite_operation_id}"

payload = {
"kwhc": 123,
"cee_amount": 123,
"aides_informations": ["<string>"],
"external_reference": "<string>",
"cdp_amount": 123,
"mpr_amount": 123,
"fost_version": "<string>",
"ah_informations": ["<string>"],
"commitment_date": "<string>",
"invoice_reference": "<string>",
"material_ids": ["<string>"],
"completion_proof_date": "<string>",
"subcontractor_id": 123,
"quote_reference": "<string>",
"custom_status_id": 123
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
kwhc: 123,
cee_amount: 123,
aides_informations: ['<string>'],
external_reference: '<string>',
cdp_amount: 123,
mpr_amount: 123,
fost_version: '<string>',
ah_informations: ['<string>'],
commitment_date: '<string>',
invoice_reference: '<string>',
material_ids: ['<string>'],
completion_proof_date: '<string>',
subcontractor_id: 123,
quote_reference: '<string>',
custom_status_id: 123
})
};

fetch('https://api.opx.co/partners/v1/worksites/{id}/operations/{worksite_operation_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.opx.co/partners/v1/worksites/{id}/operations/{worksite_operation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'kwhc' => 123,
'cee_amount' => 123,
'aides_informations' => [
'<string>'
],
'external_reference' => '<string>',
'cdp_amount' => 123,
'mpr_amount' => 123,
'fost_version' => '<string>',
'ah_informations' => [
'<string>'
],
'commitment_date' => '<string>',
'invoice_reference' => '<string>',
'material_ids' => [
'<string>'
],
'completion_proof_date' => '<string>',
'subcontractor_id' => 123,
'quote_reference' => '<string>',
'custom_status_id' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.opx.co/partners/v1/worksites/{id}/operations/{worksite_operation_id}"

payload := strings.NewReader("{\n \"kwhc\": 123,\n \"cee_amount\": 123,\n \"aides_informations\": [\n \"<string>\"\n ],\n \"external_reference\": \"<string>\",\n \"cdp_amount\": 123,\n \"mpr_amount\": 123,\n \"fost_version\": \"<string>\",\n \"ah_informations\": [\n \"<string>\"\n ],\n \"commitment_date\": \"<string>\",\n \"invoice_reference\": \"<string>\",\n \"material_ids\": [\n \"<string>\"\n ],\n \"completion_proof_date\": \"<string>\",\n \"subcontractor_id\": 123,\n \"quote_reference\": \"<string>\",\n \"custom_status_id\": 123\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.opx.co/partners/v1/worksites/{id}/operations/{worksite_operation_id}")
.header("Content-Type", "application/json")
.body("{\n \"kwhc\": 123,\n \"cee_amount\": 123,\n \"aides_informations\": [\n \"<string>\"\n ],\n \"external_reference\": \"<string>\",\n \"cdp_amount\": 123,\n \"mpr_amount\": 123,\n \"fost_version\": \"<string>\",\n \"ah_informations\": [\n \"<string>\"\n ],\n \"commitment_date\": \"<string>\",\n \"invoice_reference\": \"<string>\",\n \"material_ids\": [\n \"<string>\"\n ],\n \"completion_proof_date\": \"<string>\",\n \"subcontractor_id\": 123,\n \"quote_reference\": \"<string>\",\n \"custom_status_id\": 123\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.opx.co/partners/v1/worksites/{id}/operations/{worksite_operation_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"kwhc\": 123,\n \"cee_amount\": 123,\n \"aides_informations\": [\n \"<string>\"\n ],\n \"external_reference\": \"<string>\",\n \"cdp_amount\": 123,\n \"mpr_amount\": 123,\n \"fost_version\": \"<string>\",\n \"ah_informations\": [\n \"<string>\"\n ],\n \"commitment_date\": \"<string>\",\n \"invoice_reference\": \"<string>\",\n \"material_ids\": [\n \"<string>\"\n ],\n \"completion_proof_date\": \"<string>\",\n \"subcontractor_id\": 123,\n \"quote_reference\": \"<string>\",\n \"custom_status_id\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": 123,
    "external_reference": "<string>",
    "worksite_id": 123,
    "operation_id": 123,
    "status": "<string>",
    "code": "<string>",
    "fost_version": "<string>",
    "classic_kwhc": "<string>",
    "precarity_kwhc": "<string>",
    "cee_amount": "<string>",
    "cee_amount_total": "<string>",
    "cdp_amount": "<string>",
    "cdp_amount_total": "<string>",
    "mpr_amount": "<string>",
    "invoice_reference": "<string>",
    "aides_informations": [
      "<unknown>"
    ],
    "ah_informations": [
      "<unknown>"
    ],
    "material_ids": [
      "<unknown>"
    ],
    "completion_proof_date": "<string>",
    "commitment_date": "<string>",
    "subcontractor_id": 123,
    "custom_worksite_operation_status_id": "<string>",
    "custom_worksite_operation_status_label": "<string>",
    "quote_reference": "<string>"
  }
}
{
"message": "<string>",
"errors": {}
}

Path Parameters

id
integer
required
worksite_operation_id
integer
required

Body

application/json
kwhc
number
cee_amount
number

prime reversée au bénéficiaire

aides_informations
string[]

voir https:docs.opx.co/partners-api/operations/operation-aids-parameters-list

external_reference
string | null

Nullable fields that require kwhc, cee_amount, aides_informations when present

Maximum string length: 255
cdp_amount
number | null
mpr_amount
number | null
fost_version
string | null
Maximum string length: 255
ah_informations
string[] | null

voir https:docs.opx.co/partners-api/operations/operation-ah-parameters-list

commitment_date
string | null
invoice_reference
string | null

Simple update fields (can be updated without required parameters)

Maximum string length: 255
material_ids
string[] | null
completion_proof_date
string | null
subcontractor_id
integer | null
quote_reference
string | null

référence du devis

Maximum string length: 255
custom_status_id
integer | null

statut personnalisé à assigner

Response

WorksiteOperationResource

data
WorksiteOperationResource · object
required