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": "8e329ca0-e6e0-4437-8b80-4827be66a836",
"jobs_id": "0df72102-fcff-4645-824f-00e9943f61cb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b52b113d-9cb5-4ebe-964a-6c21c3cf3b08",
"_parent_id": "19ce5fe2-c22c-4f2c-961e-1131e4ccf691",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "05e60bfe-a384-4986-b307-fe060090980a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ec50018f-cdac-44db-a0d6-dc820c0b4846",
"_parent_id": "3952f637-6e52-4987-a3ce-3fca137ad1a6",
"root_parent_id": "627bfd75-f712-4af1-a515-a87ba3138190",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6f51686b-53d3-4619-948e-bba071c5d29d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ca46aade-aff8-4022-b4b5-a6c13e5e4d11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cec97eb9-33cd-4759-a3e6-a04daf9022b1",
"_parent_code": "sample string 6",
"sales_organization_id": "dbba98b7-215a-4583-9643-cfd86710c0d1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e06b4abd-6e67-494b-b21b-c6fb92322f2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "144e1087-9980-4aba-97cb-995cd4f299f3",
"db_currency_id": "b7faa2e8-b4e5-42e3-8b79-bb567164043d",
"db_language_id": "ac5856b7-7210-47cc-98e3-f16d9de48564",
"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-05T20:14:20.0458573+00:00"
},
"modified_dateutc": "2025-12-05T20:14:20.0458573+00:00"
},
"equipment_model_id": "f4bce822-9f27-45dd-b59c-0463a835984b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b0546127-481d-40e3-a663-84ae103110b8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8f3d1ef3-8c86-4244-9c71-7fc500dbe438",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ef1ff187-336b-4569-85ae-28fd78231edd",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5c872c4c-8d3f-4f4d-8a53-653a9dbdc97f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e06b4abd-6e67-494b-b21b-c6fb92322f2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "144e1087-9980-4aba-97cb-995cd4f299f3",
"db_currency_id": "b7faa2e8-b4e5-42e3-8b79-bb567164043d",
"db_language_id": "ac5856b7-7210-47cc-98e3-f16d9de48564",
"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-05T20:14:20.0458573+00:00"
},
"modified_dateutc": "2025-12-05T20:14:20.0614843+00:00"
},
"equipment_family_id": "c3c1af66-004c-4fec-92a9-604fe5618aa6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ca46aade-aff8-4022-b4b5-a6c13e5e4d11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cec97eb9-33cd-4759-a3e6-a04daf9022b1",
"_parent_code": "sample string 6",
"sales_organization_id": "dbba98b7-215a-4583-9643-cfd86710c0d1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e06b4abd-6e67-494b-b21b-c6fb92322f2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "144e1087-9980-4aba-97cb-995cd4f299f3",
"db_currency_id": "b7faa2e8-b4e5-42e3-8b79-bb567164043d",
"db_language_id": "ac5856b7-7210-47cc-98e3-f16d9de48564",
"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-05T20:14:20.0458573+00:00"
},
"modified_dateutc": "2025-12-05T20:14:20.0458573+00:00"
},
"date_in_production_since": "2025-12-05T20:14:20.0614843+00:00",
"date_out_of_production_since": "2025-12-05T20:14:20.0614843+00:00",
"date_end_support": "2025-12-05T20:14:20.0614843+00:00",
"sales_organization_id": "9bc18273-7275-4a13-bd3d-6d2464162938",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e06b4abd-6e67-494b-b21b-c6fb92322f2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "144e1087-9980-4aba-97cb-995cd4f299f3",
"db_currency_id": "b7faa2e8-b4e5-42e3-8b79-bb567164043d",
"db_language_id": "ac5856b7-7210-47cc-98e3-f16d9de48564",
"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-05T20:14:20.0458573+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-05T20:14:20.0614843+00:00"
},
"project_status_id": "6f088f47-f7e6-4294-a0e0-1bd7eed55cbe",
"project_status_code": "sample string 10",
"project_status": {
"id": "4e2c1993-2341-46dd-9686-8b1d2298a8db",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "388f5e1c-127e-4502-8874-b2f903d41935",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e06b4abd-6e67-494b-b21b-c6fb92322f2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "144e1087-9980-4aba-97cb-995cd4f299f3",
"db_currency_id": "b7faa2e8-b4e5-42e3-8b79-bb567164043d",
"db_language_id": "ac5856b7-7210-47cc-98e3-f16d9de48564",
"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-05T20:14:20.0458573+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T20:14:20.0614843+00:00"
},
"company_id": "68d11f68-5587-4871-9b26-047340402ebe",
"company_code": "sample string 12",
"db_address_id": "ef6cb845-504f-420d-a60b-2abebf98ce1c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4cbe7f5a-b1f1-4816-992d-d41b4e327510",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0d1f24d7-bfc9-455d-b19b-2572b9843dce",
"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-05T20:14:20.0614843+00:00",
"date_create": "2025-12-05T20:14:20.0614843+00:00",
"date_update": "2025-12-05T20:14:20.0614843+00:00",
"updated_by_user_id": "f82106a4-c28b-460a-b3c0-3f5a3dce8108",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-05T20:14:20.0614843+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-05T20:14:20.0614843+00:00",
"date_last_job": "2025-12-05T20:14:20.0614843+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-05T20:14:20.0614843+00:00",
"modified_dateutc": "2025-12-05T20:14:20.0614843+00:00",
"is_mobile_installation": true
},
"job_type_id": "dcbe7ba0-9d30-410d-974f-b4c441d44d14",
"job_type_code": "sample string 7",
"job_type": {
"id": "aa0a89b2-8e44-4ef6-be13-89f0eb715924",
"name": "sample string 2",
"sales_organization_id": "72ed3e36-0575-4c20-82ce-1aa7cd0c7503",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-05T20:14:20.0614843+00:00",
"code": "sample string 7"
},
"job_priority_id": "44acb0f2-1e94-438a-9fbf-2e865a0896e2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8dfb269a-e2fb-4c23-8728-321c86867db1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cb56cf39-6b1b-40a9-b112-8bc322fdeef1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e06b4abd-6e67-494b-b21b-c6fb92322f2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "144e1087-9980-4aba-97cb-995cd4f299f3",
"db_currency_id": "b7faa2e8-b4e5-42e3-8b79-bb567164043d",
"db_language_id": "ac5856b7-7210-47cc-98e3-f16d9de48564",
"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-05T20:14:20.0458573+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T20:14:20.0614843+00:00"
},
"job_status_id": "4044e30a-8606-4c13-b9f5-0332c2e114bb",
"job_status_code": "sample string 11",
"db_address_id": "f5c53fda-e502-4d5f-8ac8-af234295c71a",
"contact_id": "84d179ca-5915-4a30-a031-3848e4d8f2da",
"requested_by_company_id": "44b8449e-5f67-45fb-982b-beda9bcba916",
"requested_by_contact_id": "6e22fa55-edf3-4e67-a5aa-137666e885da",
"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-05T20:14:20.0614843+00:00",
"due_date": "2025-12-05T20:14:20.0614843+00:00",
"date_create": "2025-12-05T20:14:20.0614843+00:00",
"date_update": "2025-12-05T20:14:20.0614843+00:00",
"date_closed": "2025-12-05T20:14:20.0614843+00:00",
"suggested_user_id": "ba5241e6-d866-4b8b-89f3-3650c2d4c80e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e07a43c8-6ccc-40ac-bcbe-4938480ee632",
"db_language_id": "f9a95095-c071-47b2-be45-9646b212bdc0",
"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-05T20:14:20.0614843+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "117ae5b2-3c26-421f-920d-b6542e59a0da",
"sales_organization": {
"id": "e06b4abd-6e67-494b-b21b-c6fb92322f2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "144e1087-9980-4aba-97cb-995cd4f299f3",
"db_currency_id": "b7faa2e8-b4e5-42e3-8b79-bb567164043d",
"db_language_id": "ac5856b7-7210-47cc-98e3-f16d9de48564",
"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-05T20:14:20.0458573+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f932c4b7-0025-42c2-9036-727cf57cab95",
"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": "44ac7231-2238-4a79-92aa-7bc7ee741355",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-05T20:14:20.0614843+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "13c89e87-fbad-4ccf-b631-a45a11d62769"
},
"suggested_date_start": "2025-12-05T20:14:20.0614843+00:00",
"skill_id": "1c521aa3-b7dc-4084-98a8-fc1cb180edee",
"skill_code": "sample string 32",
"skill": {
"id": "c66a36ac-a30b-48ab-8b54-b8d338679f3b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d51aa622-dbb9-461f-9e7d-c508bdd92362",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e06b4abd-6e67-494b-b21b-c6fb92322f2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "144e1087-9980-4aba-97cb-995cd4f299f3",
"db_currency_id": "b7faa2e8-b4e5-42e3-8b79-bb567164043d",
"db_language_id": "ac5856b7-7210-47cc-98e3-f16d9de48564",
"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-05T20:14:20.0458573+00:00"
},
"modified_dateutc": "2025-12-05T20:14:20.0614843+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f32cd7e4-92ce-4034-937f-19b555c3d1bd",
"date_reported_by_company": "2025-12-05T20:14:20.0614843+00:00",
"id2": 36,
"company_id": "d264b532-6b63-4334-a05d-e6aedf98c3a7",
"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": "17f2f070-855a-40f7-9e0b-c4d0bfa8d042",
"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-05T20:14:20.0614843+00:00"
},
"work_instruction_details_id": "d134b0f4-b56a-49d5-9269-1f9b4b19e03d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bd9d84e8-ff86-4c26-869b-0d1049438a11",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6aee9b9c-0432-422e-8e5f-6b31b8fa994c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-05T20:14:20.0614843+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": "688a7f47-997f-4a65-b07c-8965255be567",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-05T20:14:20.0614843+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.