Updates the job work instruction list with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "3ab2430d-0233-4c53-8fd2-427f0093b868",
"jobs_id": "a1ed16c5-fe41-46e0-9840-8e440c7af176",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5fb2cecb-e7f3-47af-8dad-2d126c3cf3dd",
"_parent_id": "67c21b6f-1dba-4ee0-96db-9015b0365491",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bfa85d55-aa43-4dba-be1f-e770563fe9bc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "30b2b4fb-d774-4e81-b556-a53e8f0fa72c",
"_parent_id": "c796fe6e-9b6b-46bd-9d11-05424dec500f",
"root_parent_id": "bc63db94-bd40-499c-937c-06da75475ac3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6c23265e-7961-44f9-9cfa-2b218f5da7eb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dc7a407c-d950-4ee8-a051-8c96ab8173c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7b095d6f-a9f9-40cc-a194-7f3a1f21dfc6",
"_parent_code": "sample string 6",
"sales_organization_id": "20bdf8c2-70fb-4b37-8612-8f60ba856aa9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d038a3b3-c39d-44d2-a560-4db2ea581f47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81968ef2-d05b-45fa-a602-9def767a5457",
"db_currency_id": "3bf43647-a82b-4279-b3bc-518473a5888e",
"db_language_id": "9f7f0095-6ac7-4ddb-92f5-6ba0543e2b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"equipment_model_id": "6d13be48-7acd-4f7e-b000-4f47155615c8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "dc6910af-7ed5-49ca-a0d9-7e1d311529ff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7b5e248d-f2f8-4db0-9516-cb3870f533ba",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8884273b-b431-4853-b408-3a25074ed1f7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "650cd789-cd60-41a1-b818-de2bd5c6a888",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d038a3b3-c39d-44d2-a560-4db2ea581f47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81968ef2-d05b-45fa-a602-9def767a5457",
"db_currency_id": "3bf43647-a82b-4279-b3bc-518473a5888e",
"db_language_id": "9f7f0095-6ac7-4ddb-92f5-6ba0543e2b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"equipment_family_id": "75fa176c-bf42-4f4a-804f-d3eedd1f3a6e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dc7a407c-d950-4ee8-a051-8c96ab8173c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7b095d6f-a9f9-40cc-a194-7f3a1f21dfc6",
"_parent_code": "sample string 6",
"sales_organization_id": "20bdf8c2-70fb-4b37-8612-8f60ba856aa9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d038a3b3-c39d-44d2-a560-4db2ea581f47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81968ef2-d05b-45fa-a602-9def767a5457",
"db_currency_id": "3bf43647-a82b-4279-b3bc-518473a5888e",
"db_language_id": "9f7f0095-6ac7-4ddb-92f5-6ba0543e2b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"date_in_production_since": "2025-11-12T21:52:03.377584+00:00",
"date_out_of_production_since": "2025-11-12T21:52:03.377584+00:00",
"date_end_support": "2025-11-12T21:52:03.377584+00:00",
"sales_organization_id": "d458b22e-ea84-47af-91ed-fffa71705065",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d038a3b3-c39d-44d2-a560-4db2ea581f47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81968ef2-d05b-45fa-a602-9def767a5457",
"db_currency_id": "3bf43647-a82b-4279-b3bc-518473a5888e",
"db_language_id": "9f7f0095-6ac7-4ddb-92f5-6ba0543e2b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"project_status_id": "01f55171-f7fa-4b64-8e1e-9916e9094b5c",
"project_status_code": "sample string 10",
"project_status": {
"id": "a3f3048c-03b0-49eb-9e7e-b8bb0441ee01",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a2f45a92-8b00-46e2-9bbf-0dd632f8cbcb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d038a3b3-c39d-44d2-a560-4db2ea581f47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81968ef2-d05b-45fa-a602-9def767a5457",
"db_currency_id": "3bf43647-a82b-4279-b3bc-518473a5888e",
"db_language_id": "9f7f0095-6ac7-4ddb-92f5-6ba0543e2b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"company_id": "dc261d95-69ff-46b7-a419-c1ea3e8e54f5",
"company_code": "sample string 12",
"db_address_id": "e3850e15-7d7b-4be9-8c7b-aad99b5308c7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0c6ae4a2-a3f4-412c-8dc9-41b3d197d1e7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "def813e5-04b4-4932-b45e-858949506b89",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2025-11-12T21:52:03.377584+00:00",
"date_create": "2025-11-12T21:52:03.377584+00:00",
"date_update": "2025-11-12T21:52:03.377584+00:00",
"updated_by_user_id": "7de88439-041c-470c-bf08-069543471b41",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-12T21:52:03.377584+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2025-11-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-12T21:52:03.377584+00:00",
"date_last_job": "2025-11-12T21:52:03.377584+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-12T21:52:03.377584+00:00",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00",
"is_mobile_installation": true
},
"job_type_id": "35cc51b8-7881-4179-8cfe-12f67cce0a94",
"job_type_code": "sample string 7",
"job_type": {
"id": "6867a8bb-fcf6-4862-9777-5b21a956c005",
"name": "sample string 2",
"sales_organization_id": "78c0d3f5-f6d9-4131-bbf3-c40310dad8fa",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00",
"code": "sample string 7"
},
"job_priority_id": "3d94255a-558e-4d77-af35-4fb9c2f2d2d1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "228fd179-d511-4132-a0e1-d47aa0738f0c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "40c033ad-a77b-4ac9-b13f-bdd856065b4c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d038a3b3-c39d-44d2-a560-4db2ea581f47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81968ef2-d05b-45fa-a602-9def767a5457",
"db_currency_id": "3bf43647-a82b-4279-b3bc-518473a5888e",
"db_language_id": "9f7f0095-6ac7-4ddb-92f5-6ba0543e2b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"job_status_id": "fc40ab3f-2dab-48ac-970a-78a397b8ba32",
"job_status_code": "sample string 11",
"db_address_id": "cb527ecd-1c89-40e5-a577-06ec2850fcfa",
"contact_id": "66a54208-342c-49ee-97b0-68d6845d6ac4",
"requested_by_company_id": "ff9652cd-992c-40dd-add8-c1917e905091",
"requested_by_contact_id": "23cd5c53-1e6e-4ea3-97e3-d7da39e7683d",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2025-11-12T21:52:03.377584+00:00",
"due_date": "2025-11-12T21:52:03.377584+00:00",
"date_create": "2025-11-12T21:52:03.377584+00:00",
"date_update": "2025-11-12T21:52:03.377584+00:00",
"date_closed": "2025-11-12T21:52:03.377584+00:00",
"suggested_user_id": "f57d7eec-500c-4d85-b479-435ed525d0fc",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4f474e64-1669-45a7-968e-867265aebffd",
"db_language_id": "9a804e6d-b20d-42d1-9481-26a7f754ab35",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2025-11-12T21:52:03.377584+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ee2529e1-a656-4eb5-b469-598ecf8d64ab",
"sales_organization": {
"id": "d038a3b3-c39d-44d2-a560-4db2ea581f47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81968ef2-d05b-45fa-a602-9def767a5457",
"db_currency_id": "3bf43647-a82b-4279-b3bc-518473a5888e",
"db_language_id": "9f7f0095-6ac7-4ddb-92f5-6ba0543e2b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "62280666-359d-4e26-9e06-f363b47f2aa9",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "e179b9bd-04ed-4c59-9419-9ba8a2547b56",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0d97f918-f665-484e-8e1f-4872d787fa3a"
},
"suggested_date_start": "2025-11-12T21:52:03.377584+00:00",
"skill_id": "80a66eb9-1ada-4bc5-890e-e1e731cbc5b5",
"skill_code": "sample string 32",
"skill": {
"id": "f55c9305-6286-4708-9794-4f4d89bde10c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "078d7f0f-68c8-4097-8561-ac3f7b45eaac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d038a3b3-c39d-44d2-a560-4db2ea581f47",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81968ef2-d05b-45fa-a602-9def767a5457",
"db_currency_id": "3bf43647-a82b-4279-b3bc-518473a5888e",
"db_language_id": "9f7f0095-6ac7-4ddb-92f5-6ba0543e2b1b",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8d3b6e0c-ab28-4697-a23a-76b5d9570566",
"date_reported_by_company": "2025-11-12T21:52:03.377584+00:00",
"id2": 36,
"company_id": "ff56ae81-95e6-44bf-b4ed-b211b1229292",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "592601fd-274d-4e3f-b26f-397945d45fc6",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
},
"work_instruction_details_id": "bd2c3d00-3353-4be2-ba46-97f70e32e050",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d5eabd9f-77ba-486b-b4e1-429f806346ce",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9beb9583-09a2-45b9-b77e-99e213f32bce",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-12T21:52:03.377584+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "666d622d-501f-4b4d-bd31-14503a0d5914",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-12T21:52:03.377584+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.