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": "9c2975e5-cc9c-44dd-a063-48b796c020fa",
"jobs_id": "538530f7-02ae-4e55-b1cc-213f59056d29",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "05b97142-ac8d-46b7-b53b-14b5008b5d9a",
"_parent_id": "0936b8f6-e25d-427a-9b3d-8ce371884b8c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "90f2a3d0-c2ac-4848-add9-91ccedd3b194",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2855d6f4-9c46-4da1-a151-6914b0fd1076",
"_parent_id": "b1160d6d-2588-4c26-a992-c87c23368377",
"root_parent_id": "67b1bc2a-78ef-4cf6-a18e-7eb42b18a0c3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d28ca4d7-7eda-4ac3-80bf-c021d337cadf",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bec2eb23-67d9-4ae5-b84c-f7ccf4ad3b51",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aa3ae299-007c-44e8-95d5-f1239a537c4d",
"_parent_code": "sample string 6",
"sales_organization_id": "66619d4d-4dd0-43f2-85e2-ff3d9f7e65eb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c904b403-f406-44cd-9481-622459bb4d56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e44cd6df-0a25-409e-8b2e-d89830e93927",
"db_currency_id": "f171f22d-3cee-4ff8-970c-40e434f78d16",
"db_language_id": "08a1d35f-8c30-4903-a0a4-ce506e843c68",
"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-07-31T19:29:43.4470508+00:00"
},
"modified_dateutc": "2026-07-31T19:29:43.4470508+00:00"
},
"equipment_model_id": "e53383c9-af1b-4cc9-8da4-140b78eb36c6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9831a46a-00b6-4535-bc06-c018e30d472c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "38f150fe-a599-4c68-a33a-c6fcb87d0549",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cb70d395-5d59-4fae-8d51-49f693cbc493",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f310cdd3-a31d-4104-ad36-41684688a0ac",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c904b403-f406-44cd-9481-622459bb4d56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e44cd6df-0a25-409e-8b2e-d89830e93927",
"db_currency_id": "f171f22d-3cee-4ff8-970c-40e434f78d16",
"db_language_id": "08a1d35f-8c30-4903-a0a4-ce506e843c68",
"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-07-31T19:29:43.4470508+00:00"
},
"modified_dateutc": "2026-07-31T19:29:43.4470508+00:00"
},
"equipment_family_id": "90ad88e2-e747-4595-b7ef-9fe42c323c7f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bec2eb23-67d9-4ae5-b84c-f7ccf4ad3b51",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aa3ae299-007c-44e8-95d5-f1239a537c4d",
"_parent_code": "sample string 6",
"sales_organization_id": "66619d4d-4dd0-43f2-85e2-ff3d9f7e65eb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c904b403-f406-44cd-9481-622459bb4d56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e44cd6df-0a25-409e-8b2e-d89830e93927",
"db_currency_id": "f171f22d-3cee-4ff8-970c-40e434f78d16",
"db_language_id": "08a1d35f-8c30-4903-a0a4-ce506e843c68",
"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-07-31T19:29:43.4470508+00:00"
},
"modified_dateutc": "2026-07-31T19:29:43.4470508+00:00"
},
"date_in_production_since": "2026-07-31T19:29:43.4626764+00:00",
"date_out_of_production_since": "2026-07-31T19:29:43.4626764+00:00",
"date_end_support": "2026-07-31T19:29:43.4626764+00:00",
"sales_organization_id": "5dde3415-6e82-4097-a565-e164389090d4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c904b403-f406-44cd-9481-622459bb4d56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e44cd6df-0a25-409e-8b2e-d89830e93927",
"db_currency_id": "f171f22d-3cee-4ff8-970c-40e434f78d16",
"db_language_id": "08a1d35f-8c30-4903-a0a4-ce506e843c68",
"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-07-31T19:29:43.4470508+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-07-31T19:29:43.4626764+00:00"
},
"project_status_id": "fe67a583-6285-4af6-a518-0d4103169168",
"project_status_code": "sample string 10",
"project_status": {
"id": "af649e68-663b-48fd-ac22-8faf235788e3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f10bacef-5192-40d7-80ab-8ae8edfff3c8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c904b403-f406-44cd-9481-622459bb4d56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e44cd6df-0a25-409e-8b2e-d89830e93927",
"db_currency_id": "f171f22d-3cee-4ff8-970c-40e434f78d16",
"db_language_id": "08a1d35f-8c30-4903-a0a4-ce506e843c68",
"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-07-31T19:29:43.4470508+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-31T19:29:43.4626764+00:00"
},
"company_id": "9386e61e-22b8-45b2-97ca-487322e39205",
"company_code": "sample string 12",
"db_address_id": "410b6686-fbe7-471b-9d7c-4f74635801c9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "75eb0129-b7bf-4858-9481-37280766a7c3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f1682c6f-b325-4945-bd13-202dc955196d",
"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-07-31T19:29:43.4626764+00:00",
"date_create": "2026-07-31T19:29:43.4626764+00:00",
"date_update": "2026-07-31T19:29:43.4626764+00:00",
"updated_by_user_id": "b642f3d4-1eb5-48a8-aabe-c1737b2a9114",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-31T19:29:43.4626764+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-07-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-31T19:29:43.4626764+00:00",
"date_last_job": "2026-07-31T19:29:43.4626764+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-31T19:29:43.4626764+00:00",
"modified_dateutc": "2026-07-31T19:29:43.4626764+00:00",
"is_mobile_installation": true
},
"job_type_id": "e057687e-d804-414a-8324-4cc91a37d272",
"job_type_code": "sample string 7",
"job_type": {
"id": "794b863c-4686-4a1d-bf5e-c7e7cb27770e",
"name": "sample string 2",
"sales_organization_id": "2e74ec68-f4da-44b3-b7c4-2506aed35e54",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-31T19:29:43.4626764+00:00",
"code": "sample string 7"
},
"job_priority_id": "2b633330-21f1-45f6-8cdc-5252d29642fa",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "775fb289-d893-4d5c-a11d-5f588343f4a4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "05fc4fb5-88b7-4015-9457-6c03028cd68b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c904b403-f406-44cd-9481-622459bb4d56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e44cd6df-0a25-409e-8b2e-d89830e93927",
"db_currency_id": "f171f22d-3cee-4ff8-970c-40e434f78d16",
"db_language_id": "08a1d35f-8c30-4903-a0a4-ce506e843c68",
"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-07-31T19:29:43.4470508+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-31T19:29:43.4626764+00:00"
},
"job_status_id": "ab03734e-570e-482d-9184-406fdc007e53",
"job_status_code": "sample string 11",
"db_address_id": "057c9108-7ec9-44be-896f-018a8141006a",
"contact_id": "4b3e31eb-760c-43b8-b82a-c660ea730f97",
"requested_by_company_id": "e4da29a0-fb2d-47a3-93d2-a2390d292ac2",
"requested_by_contact_id": "ff817dd1-9216-49c6-ad46-d515f45a36db",
"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-07-31T19:29:43.4626764+00:00",
"due_date": "2026-07-31T19:29:43.4626764+00:00",
"date_create": "2026-07-31T19:29:43.4626764+00:00",
"date_update": "2026-07-31T19:29:43.4626764+00:00",
"date_closed": "2026-07-31T19:29:43.4626764+00:00",
"suggested_user_id": "55f0f462-7d67-4852-99e9-a6a0f22af5dd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6d732979-6064-4500-90d8-ac8c8d69afcd",
"db_language_id": "e2d8d437-618e-4ec5-93b2-3e80061a9f76",
"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-07-31T19:29:43.4626764+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "04bcecfc-932f-48d8-8fed-9c3ba35491ab",
"sales_organization": {
"id": "c904b403-f406-44cd-9481-622459bb4d56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e44cd6df-0a25-409e-8b2e-d89830e93927",
"db_currency_id": "f171f22d-3cee-4ff8-970c-40e434f78d16",
"db_language_id": "08a1d35f-8c30-4903-a0a4-ce506e843c68",
"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-07-31T19:29:43.4470508+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e98594a6-6b94-4232-b62f-a2dd1c63b531",
"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": "2a0bbbd4-14cf-4cc1-a82c-05b816280334",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-31T19:29:43.4626764+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "84f7138a-28ea-49e5-998c-3d62c61f5530"
},
"suggested_date_start": "2026-07-31T19:29:43.4626764+00:00",
"skill_id": "f708b9c5-bd71-455f-b2b5-4f5365ae46df",
"skill_code": "sample string 32",
"skill": {
"id": "cb8371f8-8246-48d0-b69b-bfc7791dcbde",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ffa6a02a-21e1-46c1-a0ac-494254c63989",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c904b403-f406-44cd-9481-622459bb4d56",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e44cd6df-0a25-409e-8b2e-d89830e93927",
"db_currency_id": "f171f22d-3cee-4ff8-970c-40e434f78d16",
"db_language_id": "08a1d35f-8c30-4903-a0a4-ce506e843c68",
"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-07-31T19:29:43.4470508+00:00"
},
"modified_dateutc": "2026-07-31T19:29:43.4626764+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5dc536ca-df91-46f5-8dbd-7729e31c2e1a",
"date_reported_by_company": "2026-07-31T19:29:43.4626764+00:00",
"id2": 36,
"company_id": "833c24b8-da05-4a9d-8535-23457a25c58a",
"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": "9f950468-94e8-4770-8d44-78aa5a9259a6",
"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-07-31T19:29:43.4626764+00:00"
},
"work_instruction_details_id": "c50a2a38-9192-4b56-a823-a31a9244167e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3fa6160a-1e99-4275-a0b7-c1ff5d9dcaa7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5840065c-2b0b-4971-94fe-cce817df5a9c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-31T19:29:43.4626764+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": "087a8681-c556-4374-8876-feacf9128854",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-31T19:29:43.4626764+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.