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": "6ab7dc45-268a-4046-b869-33db146e0908",
"jobs_id": "8fd6e039-e1af-410f-b13c-b792f6d5d974",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "acfb78fd-880b-4825-9764-6d138711a47d",
"_parent_id": "82cd64e8-8c07-4579-9c4b-340699a26210",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a5437570-9825-449e-9c02-8d2b727d8592",
"project_reference_back_office": "sample string 5",
"project": {
"id": "56a4542c-eadb-4a38-bbd5-34f6ce0a6be0",
"_parent_id": "81dc68d4-6573-43f8-b234-c861c71bd9b4",
"root_parent_id": "ab58afdb-dc76-452b-ab48-703964fbb466",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0748a071-5eb0-4d36-b9d8-491a6e71dcfd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "731333ce-3a5f-4496-bf99-c0512328684d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "da41a119-9c21-4e49-9786-cc63774577f9",
"_parent_code": "sample string 6",
"sales_organization_id": "1b199836-c644-4a09-a4c0-465f6ec65afa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4480cafc-d905-4c95-8205-ec054023cb72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "059cb463-d704-4b7e-8c87-c85b720d22a2",
"db_currency_id": "8fc5e197-e3ae-4815-b227-5b1aa852b427",
"db_language_id": "3bdbb2a2-e6b5-4c01-aa5d-45f003cbe05c",
"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": "2026-05-21T14:46:57.5258864+00:00"
},
"modified_dateutc": "2026-05-21T14:46:57.5258864+00:00"
},
"equipment_model_id": "5fd7578c-41bd-4679-a10c-222991384e6c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b98be420-7ed1-4aed-b70c-ef97b5970f16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ed85ffd2-5e23-4dfe-b21d-07cab84c6eec",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "85812c0d-84bf-4f6b-b8ae-8d0f864dc216",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c8a26ef6-8496-41f3-97d2-12e8eb53b9fd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4480cafc-d905-4c95-8205-ec054023cb72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "059cb463-d704-4b7e-8c87-c85b720d22a2",
"db_currency_id": "8fc5e197-e3ae-4815-b227-5b1aa852b427",
"db_language_id": "3bdbb2a2-e6b5-4c01-aa5d-45f003cbe05c",
"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": "2026-05-21T14:46:57.5258864+00:00"
},
"modified_dateutc": "2026-05-21T14:46:57.5258864+00:00"
},
"equipment_family_id": "4e3bbdd6-7e22-4e94-8248-66401fe776af",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "731333ce-3a5f-4496-bf99-c0512328684d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "da41a119-9c21-4e49-9786-cc63774577f9",
"_parent_code": "sample string 6",
"sales_organization_id": "1b199836-c644-4a09-a4c0-465f6ec65afa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4480cafc-d905-4c95-8205-ec054023cb72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "059cb463-d704-4b7e-8c87-c85b720d22a2",
"db_currency_id": "8fc5e197-e3ae-4815-b227-5b1aa852b427",
"db_language_id": "3bdbb2a2-e6b5-4c01-aa5d-45f003cbe05c",
"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": "2026-05-21T14:46:57.5258864+00:00"
},
"modified_dateutc": "2026-05-21T14:46:57.5258864+00:00"
},
"date_in_production_since": "2026-05-21T14:46:57.5258864+00:00",
"date_out_of_production_since": "2026-05-21T14:46:57.5258864+00:00",
"date_end_support": "2026-05-21T14:46:57.5258864+00:00",
"sales_organization_id": "665ce7c5-7e31-44d1-9f8c-415fe5eed5d3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4480cafc-d905-4c95-8205-ec054023cb72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "059cb463-d704-4b7e-8c87-c85b720d22a2",
"db_currency_id": "8fc5e197-e3ae-4815-b227-5b1aa852b427",
"db_language_id": "3bdbb2a2-e6b5-4c01-aa5d-45f003cbe05c",
"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": "2026-05-21T14:46:57.5258864+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": "2026-05-21T14:46:57.5258864+00:00"
},
"project_status_id": "7cdada1d-5977-4e6a-a9af-71607590c114",
"project_status_code": "sample string 10",
"project_status": {
"id": "4262fdc2-bab2-4a7e-bf34-ba9c7bf7667c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "82c143f2-d2ce-4d34-bcd3-626125fbabee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4480cafc-d905-4c95-8205-ec054023cb72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "059cb463-d704-4b7e-8c87-c85b720d22a2",
"db_currency_id": "8fc5e197-e3ae-4815-b227-5b1aa852b427",
"db_language_id": "3bdbb2a2-e6b5-4c01-aa5d-45f003cbe05c",
"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": "2026-05-21T14:46:57.5258864+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T14:46:57.5258864+00:00"
},
"company_id": "fa70392f-c501-419a-933c-022234796e16",
"company_code": "sample string 12",
"db_address_id": "0b827a25-07dc-41b8-af07-432b37eefde1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0bd5ba09-f4cd-4ae0-a8ac-026b4f4d04c3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cca137a0-4d1e-4d66-a2c9-a1a5975e5e47",
"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": "2026-05-21T14:46:57.5258864+00:00",
"date_create": "2026-05-21T14:46:57.5258864+00:00",
"date_update": "2026-05-21T14:46:57.5258864+00:00",
"updated_by_user_id": "7d428bcc-f69a-4cb8-ade3-ffd423cae6e1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-21T14:46:57.5258864+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": "2026-05-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-21T14:46:57.5258864+00:00",
"date_last_job": "2026-05-21T14:46:57.5258864+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-21T14:46:57.5258864+00:00",
"modified_dateutc": "2026-05-21T14:46:57.5258864+00:00",
"is_mobile_installation": true
},
"job_type_id": "2a1c3cc8-c4f0-451c-8605-7791ce8ec549",
"job_type_code": "sample string 7",
"job_type": {
"id": "20b43ebb-2379-4e7d-b0f2-1d68250d47d8",
"name": "sample string 2",
"sales_organization_id": "f5595e89-14bf-4a7f-a3b6-2b7276381489",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-21T14:46:57.5258864+00:00",
"code": "sample string 7"
},
"job_priority_id": "e4bcc3c9-9e22-4d3a-ad30-5ee9b4d41b16",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "49d113f5-3ae1-472f-828d-2b84ba0e98ca",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6c35885b-31d9-4fb6-b770-3c4c7178a692",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4480cafc-d905-4c95-8205-ec054023cb72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "059cb463-d704-4b7e-8c87-c85b720d22a2",
"db_currency_id": "8fc5e197-e3ae-4815-b227-5b1aa852b427",
"db_language_id": "3bdbb2a2-e6b5-4c01-aa5d-45f003cbe05c",
"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": "2026-05-21T14:46:57.5258864+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T14:46:57.5258864+00:00"
},
"job_status_id": "e32199e4-6f46-4a5c-8e34-571a50563e99",
"job_status_code": "sample string 11",
"db_address_id": "3afbff06-5c8b-4028-ae42-701fb36a52a7",
"contact_id": "cf6c9090-d2b1-4891-baae-432e1d0d49df",
"requested_by_company_id": "9e129226-dde7-490b-8a32-15d521281f8f",
"requested_by_contact_id": "009a5c0d-8355-42d2-b555-b83853457c30",
"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": "2026-05-21T14:46:57.5258864+00:00",
"due_date": "2026-05-21T14:46:57.5258864+00:00",
"date_create": "2026-05-21T14:46:57.5258864+00:00",
"date_update": "2026-05-21T14:46:57.5258864+00:00",
"date_closed": "2026-05-21T14:46:57.5258864+00:00",
"suggested_user_id": "56ae17ff-e669-4676-ae0e-331b627c52b4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "956b4a98-2ca5-4c4c-88fb-753014869514",
"db_language_id": "9111c2af-a503-4dad-b354-28b9e1d4e68e",
"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": "2026-05-21T14:46:57.5258864+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bfdb444d-f510-4cea-abde-34d634ca7706",
"sales_organization": {
"id": "4480cafc-d905-4c95-8205-ec054023cb72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "059cb463-d704-4b7e-8c87-c85b720d22a2",
"db_currency_id": "8fc5e197-e3ae-4815-b227-5b1aa852b427",
"db_language_id": "3bdbb2a2-e6b5-4c01-aa5d-45f003cbe05c",
"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": "2026-05-21T14:46:57.5258864+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e442dcde-df99-4a74-a3ca-0cf5f1405186",
"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": "6ccc1280-78b7-4a96-869a-e53f7a3af9bf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-21T14:46:57.5258864+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e9d4044d-85a9-4638-9d93-831677320762"
},
"suggested_date_start": "2026-05-21T14:46:57.5258864+00:00",
"skill_id": "9e52a78e-7399-4a18-91f9-30bf22317657",
"skill_code": "sample string 32",
"skill": {
"id": "0d7cb103-f44c-4732-8bf8-efa752cc2441",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "161a6363-e6be-4a61-a42f-51454e0659ee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4480cafc-d905-4c95-8205-ec054023cb72",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "059cb463-d704-4b7e-8c87-c85b720d22a2",
"db_currency_id": "8fc5e197-e3ae-4815-b227-5b1aa852b427",
"db_language_id": "3bdbb2a2-e6b5-4c01-aa5d-45f003cbe05c",
"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": "2026-05-21T14:46:57.5258864+00:00"
},
"modified_dateutc": "2026-05-21T14:46:57.5258864+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "52a83912-d4eb-4bd6-8f80-e70de5865c0e",
"date_reported_by_company": "2026-05-21T14:46:57.5258864+00:00",
"id2": 36,
"company_id": "d50cba7a-a97b-4082-861c-7f71422bf0b6",
"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": "472ecfce-c14d-429e-a041-0ef52ae97be6",
"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": "2026-05-21T14:46:57.5258864+00:00"
},
"work_instruction_details_id": "d6d9b059-e48d-4079-b22b-9d0fca7a19bc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c7059b73-ee92-4600-adef-755448445946",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f4bbb578-7b4f-4937-9aa4-e31b314cf578",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-21T14:46:57.5258864+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": "b972faa9-6c27-48b8-8aa9-394b5c5276c3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-21T14:46:57.5258864+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.