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": "76f55888-0820-4766-8263-27775b4d3d4a",
"jobs_id": "50c330e9-9758-4eb4-8bd3-e39a83aa85e9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9c9d3d93-5db1-4408-8d56-ecdd387e381c",
"_parent_id": "3881ad54-fca8-4b5e-8927-dba543f940e4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a5586d68-64f1-45bb-9afe-3a1d7e13e68b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "32596223-b410-4177-b266-b7715f5c8492",
"_parent_id": "657e1b53-c1da-47b6-b988-7a03429900aa",
"root_parent_id": "f6ee8ba0-5b6a-4d32-8d4d-7fe55dbccca8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8786cc62-4c2d-4a55-8f96-fc9a0e753512",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7e40c95e-ed97-46dd-af25-68a05cac3821",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8def61c6-cf8e-4239-aede-a280ae74e7dd",
"_parent_code": "sample string 6",
"sales_organization_id": "676a497c-25fe-4ab1-bef9-924d7d86eb4e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8912c9d5-98f2-4e6a-9684-111925b60ba7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb3e52e0-6772-4901-83d7-5ab4789502d8",
"db_currency_id": "122e3524-5993-4f76-8893-6e3e07cd983c",
"db_language_id": "86eced01-b80d-49ba-9fd7-8d0212f46435",
"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-04T21:14:39.2516451+00:00"
},
"modified_dateutc": "2025-12-04T21:14:39.2516451+00:00"
},
"equipment_model_id": "e05b0106-b57c-4b9f-aa16-dfe0e651104a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "dbc7919e-b16c-4ffb-8c09-128a6a170b5c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7710030f-7af7-4ded-a9f2-452a5654b64d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "722faf1f-ae09-4018-bf9c-10e3655378de",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6ead4e7b-71f6-4087-a4e7-0355fc389471",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8912c9d5-98f2-4e6a-9684-111925b60ba7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb3e52e0-6772-4901-83d7-5ab4789502d8",
"db_currency_id": "122e3524-5993-4f76-8893-6e3e07cd983c",
"db_language_id": "86eced01-b80d-49ba-9fd7-8d0212f46435",
"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-04T21:14:39.2516451+00:00"
},
"modified_dateutc": "2025-12-04T21:14:39.2516451+00:00"
},
"equipment_family_id": "6e1ffe4c-ea00-49bd-843b-b5943f30ff9c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7e40c95e-ed97-46dd-af25-68a05cac3821",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8def61c6-cf8e-4239-aede-a280ae74e7dd",
"_parent_code": "sample string 6",
"sales_organization_id": "676a497c-25fe-4ab1-bef9-924d7d86eb4e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8912c9d5-98f2-4e6a-9684-111925b60ba7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb3e52e0-6772-4901-83d7-5ab4789502d8",
"db_currency_id": "122e3524-5993-4f76-8893-6e3e07cd983c",
"db_language_id": "86eced01-b80d-49ba-9fd7-8d0212f46435",
"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-04T21:14:39.2516451+00:00"
},
"modified_dateutc": "2025-12-04T21:14:39.2516451+00:00"
},
"date_in_production_since": "2025-12-04T21:14:39.2516451+00:00",
"date_out_of_production_since": "2025-12-04T21:14:39.2516451+00:00",
"date_end_support": "2025-12-04T21:14:39.2516451+00:00",
"sales_organization_id": "6884bccd-e05a-4b2b-979b-36f2da7ed171",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8912c9d5-98f2-4e6a-9684-111925b60ba7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb3e52e0-6772-4901-83d7-5ab4789502d8",
"db_currency_id": "122e3524-5993-4f76-8893-6e3e07cd983c",
"db_language_id": "86eced01-b80d-49ba-9fd7-8d0212f46435",
"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-04T21:14:39.2516451+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-04T21:14:39.2516451+00:00"
},
"project_status_id": "ea303315-0a35-4379-8ead-b15246a11cfd",
"project_status_code": "sample string 10",
"project_status": {
"id": "589d021f-30cc-4aea-a361-ead73005f4b5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cb0ffb30-71f1-4a90-9f23-1a60d95ec4b1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8912c9d5-98f2-4e6a-9684-111925b60ba7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb3e52e0-6772-4901-83d7-5ab4789502d8",
"db_currency_id": "122e3524-5993-4f76-8893-6e3e07cd983c",
"db_language_id": "86eced01-b80d-49ba-9fd7-8d0212f46435",
"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-04T21:14:39.2516451+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-04T21:14:39.2516451+00:00"
},
"company_id": "f8d2a9f0-0151-4b9b-98e8-825988a782c1",
"company_code": "sample string 12",
"db_address_id": "6de6fad1-c107-4390-88ba-dba256ad0859",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9f33df50-b0fc-4821-b41f-f1f582088c37",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "44e1bc9b-7e8c-4466-9e33-b44482b5889d",
"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-04T21:14:39.2516451+00:00",
"date_create": "2025-12-04T21:14:39.2516451+00:00",
"date_update": "2025-12-04T21:14:39.2516451+00:00",
"updated_by_user_id": "3d87cb6c-7b73-4efc-b73d-1e982b1a6177",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-04T21:14:39.2516451+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-04T21:14:39.2516451+00:00",
"date_last_job": "2025-12-04T21:14:39.2516451+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-04T21:14:39.2516451+00:00",
"modified_dateutc": "2025-12-04T21:14:39.2516451+00:00",
"is_mobile_installation": true
},
"job_type_id": "81973a89-506a-4800-b829-29435eb01574",
"job_type_code": "sample string 7",
"job_type": {
"id": "09252e42-300f-4927-bead-55fed8c25326",
"name": "sample string 2",
"sales_organization_id": "f9d0746f-2d6b-4bb8-8b32-458b4101a791",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-04T21:14:39.2516451+00:00",
"code": "sample string 7"
},
"job_priority_id": "01bcb5e0-4372-4195-85fa-b99037136419",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2f9b2d48-bca8-4b19-a670-052538228159",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "28673b82-d9b9-48ad-84fa-72780ee99202",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8912c9d5-98f2-4e6a-9684-111925b60ba7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb3e52e0-6772-4901-83d7-5ab4789502d8",
"db_currency_id": "122e3524-5993-4f76-8893-6e3e07cd983c",
"db_language_id": "86eced01-b80d-49ba-9fd7-8d0212f46435",
"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-04T21:14:39.2516451+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-04T21:14:39.2516451+00:00"
},
"job_status_id": "96578311-e99c-41a5-9880-25a9940462a9",
"job_status_code": "sample string 11",
"db_address_id": "5c570989-19b5-4172-b6eb-f2aef6f8abb2",
"contact_id": "e03daf43-1e14-4de5-9e00-491aa52bd09b",
"requested_by_company_id": "98a941a4-27d9-463f-8d99-0097d217f277",
"requested_by_contact_id": "211e6552-8c32-4646-bb62-1b1e46d0ff9a",
"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-04T21:14:39.2516451+00:00",
"due_date": "2025-12-04T21:14:39.2516451+00:00",
"date_create": "2025-12-04T21:14:39.2516451+00:00",
"date_update": "2025-12-04T21:14:39.2516451+00:00",
"date_closed": "2025-12-04T21:14:39.2516451+00:00",
"suggested_user_id": "330c15e7-1840-46a1-a5a3-b77eb243c077",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6ac71dcd-35de-47aa-be14-bf970bb9edb7",
"db_language_id": "be04f46f-8fb0-4137-a580-8831ce4f8e08",
"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-04T21:14:39.2516451+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7b787d24-eeb5-4bad-b9fc-3fd749481171",
"sales_organization": {
"id": "8912c9d5-98f2-4e6a-9684-111925b60ba7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb3e52e0-6772-4901-83d7-5ab4789502d8",
"db_currency_id": "122e3524-5993-4f76-8893-6e3e07cd983c",
"db_language_id": "86eced01-b80d-49ba-9fd7-8d0212f46435",
"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-04T21:14:39.2516451+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b8df2cdb-b435-4af2-814c-db6f2d972067",
"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": "1f533e86-c752-4efa-a539-a7e3e94f256e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-04T21:14:39.2516451+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d72928ba-d2a0-4bb1-a9ab-4aeae0cf4768"
},
"suggested_date_start": "2025-12-04T21:14:39.2516451+00:00",
"skill_id": "7874a527-8159-4b4d-86f4-2d88823d64d9",
"skill_code": "sample string 32",
"skill": {
"id": "afbbe806-2d9a-4627-b8f7-9751f08a5568",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "09ef95de-7ea5-463b-aa5b-97341629cff8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8912c9d5-98f2-4e6a-9684-111925b60ba7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cb3e52e0-6772-4901-83d7-5ab4789502d8",
"db_currency_id": "122e3524-5993-4f76-8893-6e3e07cd983c",
"db_language_id": "86eced01-b80d-49ba-9fd7-8d0212f46435",
"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-04T21:14:39.2516451+00:00"
},
"modified_dateutc": "2025-12-04T21:14:39.2516451+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "149b33b8-bdd6-4c40-b3e5-c1127b59992e",
"date_reported_by_company": "2025-12-04T21:14:39.2516451+00:00",
"id2": 36,
"company_id": "7d70b213-7175-4434-a116-58763418a72c",
"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": "4fa13e5d-d928-4a7a-bca2-712bf18b60d5",
"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-04T21:14:39.2516451+00:00"
},
"work_instruction_details_id": "db7d2463-ee2b-476c-8051-66b4d2db7ad6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "23c5680d-3b2f-4e8b-90b8-b8a6a3610856",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "afa5cb5c-ebd8-4bda-a0ef-a927d8ca80ea",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-04T21:14:39.2516451+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": "d3b8e2e8-2ae1-41bd-b4fe-4c7af235057c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-04T21:14:39.2516451+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.