Creates a new job work instruction list.
Request Information
URI Parameters :
None.
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": "98efa434-5fe4-4ce7-9ceb-479a501a3cf1",
"jobs_id": "ed296e8c-4541-41c6-b8a6-0bf644c5db42",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "92cb2ea6-d4de-4510-bedf-f32c10cc1c02",
"_parent_id": "c7d2852d-b3f5-4ad5-bd50-77aa2981d0c7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "251a457a-9843-4d98-be31-abce8ddfe5ac",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fbe21c6e-286b-442d-9da4-3023e1dc524e",
"_parent_id": "607a514b-477a-4c00-a521-338a4219d761",
"root_parent_id": "486caed9-a163-4a8f-a8ae-a8f5edd8614f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "18708193-80b0-4099-b463-3a6af87ec695",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c0545987-a51d-49bb-ace1-080a923c6628",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0755fdc4-d167-4aeb-b690-c7b12bb9efc7",
"_parent_code": "sample string 6",
"sales_organization_id": "563a1f7c-169a-40d2-a26b-5a0a63566cb6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d837d908-6a57-499c-9403-fb06602407f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cd6d396-44b4-49f4-b7b4-edd0316a84e3",
"db_currency_id": "8ef37132-b119-45eb-8828-3e4768707bbd",
"db_language_id": "ab35262c-b0b7-42ae-b1bc-0da9565daaff",
"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-12-27T07:37:55.3764469+00:00"
},
"modified_dateutc": "2025-12-27T07:37:55.3764469+00:00"
},
"equipment_model_id": "67b73449-c737-47f8-b174-abf2bc1c0c81",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d63946ab-600f-41b5-a1c8-bc7fff063fd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "71ae414e-3c78-4c33-977f-c2a7c4f7ea33",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "65f0da4c-464b-400e-8244-52c972b376dd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f6a8703b-c00d-4048-a0cc-b6f83aeccc4e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d837d908-6a57-499c-9403-fb06602407f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cd6d396-44b4-49f4-b7b4-edd0316a84e3",
"db_currency_id": "8ef37132-b119-45eb-8828-3e4768707bbd",
"db_language_id": "ab35262c-b0b7-42ae-b1bc-0da9565daaff",
"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-12-27T07:37:55.3764469+00:00"
},
"modified_dateutc": "2025-12-27T07:37:55.3764469+00:00"
},
"equipment_family_id": "b69ffce1-ac9a-4611-b54a-31ece41540ea",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c0545987-a51d-49bb-ace1-080a923c6628",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0755fdc4-d167-4aeb-b690-c7b12bb9efc7",
"_parent_code": "sample string 6",
"sales_organization_id": "563a1f7c-169a-40d2-a26b-5a0a63566cb6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d837d908-6a57-499c-9403-fb06602407f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cd6d396-44b4-49f4-b7b4-edd0316a84e3",
"db_currency_id": "8ef37132-b119-45eb-8828-3e4768707bbd",
"db_language_id": "ab35262c-b0b7-42ae-b1bc-0da9565daaff",
"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-12-27T07:37:55.3764469+00:00"
},
"modified_dateutc": "2025-12-27T07:37:55.3764469+00:00"
},
"date_in_production_since": "2025-12-27T07:37:55.3764469+00:00",
"date_out_of_production_since": "2025-12-27T07:37:55.3764469+00:00",
"date_end_support": "2025-12-27T07:37:55.3764469+00:00",
"sales_organization_id": "4dc88598-710a-4920-ab97-4c336745ebc7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d837d908-6a57-499c-9403-fb06602407f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cd6d396-44b4-49f4-b7b4-edd0316a84e3",
"db_currency_id": "8ef37132-b119-45eb-8828-3e4768707bbd",
"db_language_id": "ab35262c-b0b7-42ae-b1bc-0da9565daaff",
"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-12-27T07:37:55.3764469+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-12-27T07:37:55.3764469+00:00"
},
"project_status_id": "2a0a27cd-f3fe-43a4-a978-732ded0e449b",
"project_status_code": "sample string 10",
"project_status": {
"id": "78e7f7fe-6630-44eb-a40b-75b5867bc5d0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2a1e386c-7f12-48bc-8c12-244f1c2b40bd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d837d908-6a57-499c-9403-fb06602407f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cd6d396-44b4-49f4-b7b4-edd0316a84e3",
"db_currency_id": "8ef37132-b119-45eb-8828-3e4768707bbd",
"db_language_id": "ab35262c-b0b7-42ae-b1bc-0da9565daaff",
"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-12-27T07:37:55.3764469+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-27T07:37:55.3764469+00:00"
},
"company_id": "f217d4c8-81d3-472f-be4b-de473e640321",
"company_code": "sample string 12",
"db_address_id": "10109aea-7c62-4e5d-b7ce-43d995546b8d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5226c60b-52bf-452a-bbce-015d5ee76891",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f36f2085-eba1-4c0d-a3a5-af6a4616207b",
"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-12-27T07:37:55.3764469+00:00",
"date_create": "2025-12-27T07:37:55.3764469+00:00",
"date_update": "2025-12-27T07:37:55.3764469+00:00",
"updated_by_user_id": "0202716f-d33b-4642-a9f5-b10743a3f976",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-27T07:37:55.3764469+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-12-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-27T07:37:55.3764469+00:00",
"date_last_job": "2025-12-27T07:37:55.3764469+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-27T07:37:55.3764469+00:00",
"modified_dateutc": "2025-12-27T07:37:55.3764469+00:00",
"is_mobile_installation": true
},
"job_type_id": "06fd1421-b105-4be7-aad2-1d73ded85954",
"job_type_code": "sample string 7",
"job_type": {
"id": "b86a4df3-f41b-4fcd-bfef-909b19708863",
"name": "sample string 2",
"sales_organization_id": "67a73340-80eb-465f-9bd9-f09080be5e6d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-27T07:37:55.3764469+00:00",
"code": "sample string 7"
},
"job_priority_id": "b2720f9f-5362-4c6d-9b08-dbd266d3474a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "292087cd-9478-498b-9f8c-c42fb637e40c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "139921f0-7684-4903-8ce4-59e8bc5d60ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d837d908-6a57-499c-9403-fb06602407f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cd6d396-44b4-49f4-b7b4-edd0316a84e3",
"db_currency_id": "8ef37132-b119-45eb-8828-3e4768707bbd",
"db_language_id": "ab35262c-b0b7-42ae-b1bc-0da9565daaff",
"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-12-27T07:37:55.3764469+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-27T07:37:55.3764469+00:00"
},
"job_status_id": "071c313f-5edc-4a3a-9a29-d90d6ab84a28",
"job_status_code": "sample string 11",
"db_address_id": "2bdab6db-5ed1-4cdd-be70-78c81d04de94",
"contact_id": "3fe9fe2e-42c7-439d-98bc-3804528f6b72",
"requested_by_company_id": "0d0ac417-3ecf-4c5c-8b37-0ad12d3f0342",
"requested_by_contact_id": "f2895c33-3e58-4560-b508-b799f29cc408",
"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-12-27T07:37:55.3764469+00:00",
"due_date": "2025-12-27T07:37:55.3764469+00:00",
"date_create": "2025-12-27T07:37:55.3764469+00:00",
"date_update": "2025-12-27T07:37:55.3764469+00:00",
"date_closed": "2025-12-27T07:37:55.3764469+00:00",
"suggested_user_id": "b87d0ade-0771-48f7-baba-831e8a715a8f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "66883114-656f-4a6a-9cc1-8b924b02db0f",
"db_language_id": "75c124c6-db0a-4847-baeb-d1dbd4f7ad6d",
"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-12-27T07:37:55.3764469+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b3a1f4f8-a7c7-4d65-9cdf-ae1ca1ffaa3f",
"sales_organization": {
"id": "d837d908-6a57-499c-9403-fb06602407f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cd6d396-44b4-49f4-b7b4-edd0316a84e3",
"db_currency_id": "8ef37132-b119-45eb-8828-3e4768707bbd",
"db_language_id": "ab35262c-b0b7-42ae-b1bc-0da9565daaff",
"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-12-27T07:37:55.3764469+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "27b83132-8ed2-4441-93d6-b49795a5b399",
"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": "0f3b14c0-0d62-441c-a208-bf5078ebd01b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-27T07:37:55.3764469+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "17f7ea36-9f8e-4b78-92c3-c8ae45c96564"
},
"suggested_date_start": "2025-12-27T07:37:55.3764469+00:00",
"skill_id": "9928b62a-4628-4705-9631-d60ee45c891f",
"skill_code": "sample string 32",
"skill": {
"id": "965b47e9-c7a8-4ec5-851e-5efba141863e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9d09d831-f602-48c2-86a9-fa68e998e805",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d837d908-6a57-499c-9403-fb06602407f2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9cd6d396-44b4-49f4-b7b4-edd0316a84e3",
"db_currency_id": "8ef37132-b119-45eb-8828-3e4768707bbd",
"db_language_id": "ab35262c-b0b7-42ae-b1bc-0da9565daaff",
"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-12-27T07:37:55.3764469+00:00"
},
"modified_dateutc": "2025-12-27T07:37:55.3764469+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4b946b9d-5258-45b4-aa17-e70ccce45e46",
"date_reported_by_company": "2025-12-27T07:37:55.3764469+00:00",
"id2": 36,
"company_id": "54de80d0-9130-4cfa-8a5a-994765cf8d58",
"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": "ae569d98-e4df-455b-b633-6df1557a27e5",
"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-12-27T07:37:55.3764469+00:00"
},
"work_instruction_details_id": "94bcef61-927d-410a-a9d9-98a21f28b64b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8acadfeb-1b69-4081-a980-bd16f56899e3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "749b918c-bab9-43fd-a8ca-82f1ee03dfd2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-27T07:37:55.392057+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": "8986b8b9-4ee7-4912-ad05-755abb5ae04f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-27T07:37:55.392057+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.