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": "4136ac1d-c9a7-48dc-b9df-4472a2171e19",
"jobs_id": "ab817fc0-5412-4b38-9a60-908ee966030e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ba6e4191-b499-4ed9-a46c-b1e25c7c9f60",
"_parent_id": "5a20821b-86d8-4777-8fb5-c1ddd98e714d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "33c27d30-a6a9-438c-884f-21ba67c8d320",
"project_reference_back_office": "sample string 5",
"project": {
"id": "46083903-524e-4c3f-a457-6bcfd966f38a",
"_parent_id": "3d26ce74-b33c-4cda-9b98-dc4be00a2751",
"root_parent_id": "fb330c92-452d-410e-b8ca-9d28890a4ea8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2043f126-24e7-4ac1-8318-5a868936f570",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b67585c7-311b-4fc5-a067-4c5b7cdcfb13",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "edc523f2-d9f6-446a-89f3-3b037e4a6879",
"_parent_code": "sample string 6",
"sales_organization_id": "603afb7f-0050-4a97-b9da-13365dc1ce55",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1df4bd9c-8ea5-4ba9-9506-e15670624fab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9fed754-5812-4f80-a8cc-6cb704054868",
"db_currency_id": "7e0db183-97e7-449f-a28b-b878f7453c93",
"db_language_id": "82d62d3e-dbe0-4292-9b63-a6d4d2ac0900",
"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-11-08T10:31:46.3929533+00:00"
},
"modified_dateutc": "2026-11-08T10:31:46.3929533+00:00"
},
"equipment_model_id": "40b4a083-cc2d-4c6d-a5c0-d6e6a0cdc81d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f6f8b6b1-4808-44d6-9cae-ce9d3b510fd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ea8348d5-d04b-41aa-a3d3-f83204302cb8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2bf8306b-f685-4c42-9672-5442d343b6f4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bb2e5a9f-45e1-491b-a2b2-1bae4aa3ee6c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1df4bd9c-8ea5-4ba9-9506-e15670624fab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9fed754-5812-4f80-a8cc-6cb704054868",
"db_currency_id": "7e0db183-97e7-449f-a28b-b878f7453c93",
"db_language_id": "82d62d3e-dbe0-4292-9b63-a6d4d2ac0900",
"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-11-08T10:31:46.3929533+00:00"
},
"modified_dateutc": "2026-11-08T10:31:46.3929533+00:00"
},
"equipment_family_id": "9f3900cd-2427-4a5e-9a06-31bd9fbfbe61",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b67585c7-311b-4fc5-a067-4c5b7cdcfb13",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "edc523f2-d9f6-446a-89f3-3b037e4a6879",
"_parent_code": "sample string 6",
"sales_organization_id": "603afb7f-0050-4a97-b9da-13365dc1ce55",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1df4bd9c-8ea5-4ba9-9506-e15670624fab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9fed754-5812-4f80-a8cc-6cb704054868",
"db_currency_id": "7e0db183-97e7-449f-a28b-b878f7453c93",
"db_language_id": "82d62d3e-dbe0-4292-9b63-a6d4d2ac0900",
"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-11-08T10:31:46.3929533+00:00"
},
"modified_dateutc": "2026-11-08T10:31:46.3929533+00:00"
},
"date_in_production_since": "2026-11-08T10:31:46.3929533+00:00",
"date_out_of_production_since": "2026-11-08T10:31:46.3929533+00:00",
"date_end_support": "2026-11-08T10:31:46.3929533+00:00",
"sales_organization_id": "1bf207e6-16c6-46f7-b1d2-02dd15fa13b8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1df4bd9c-8ea5-4ba9-9506-e15670624fab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9fed754-5812-4f80-a8cc-6cb704054868",
"db_currency_id": "7e0db183-97e7-449f-a28b-b878f7453c93",
"db_language_id": "82d62d3e-dbe0-4292-9b63-a6d4d2ac0900",
"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-11-08T10:31:46.3929533+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-11-08T10:31:46.3929533+00:00"
},
"project_status_id": "99aae75c-2fd7-461a-98e1-060e88ae7fbc",
"project_status_code": "sample string 10",
"project_status": {
"id": "730538d4-0d1b-445e-a9dd-498f06652848",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0e981bfa-3a22-4d6c-87e7-b34dcf95032f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1df4bd9c-8ea5-4ba9-9506-e15670624fab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9fed754-5812-4f80-a8cc-6cb704054868",
"db_currency_id": "7e0db183-97e7-449f-a28b-b878f7453c93",
"db_language_id": "82d62d3e-dbe0-4292-9b63-a6d4d2ac0900",
"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-11-08T10:31:46.3929533+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-08T10:31:46.3929533+00:00"
},
"company_id": "bdee3017-eb4d-46ed-ac17-8cc65c8a0b84",
"company_code": "sample string 12",
"db_address_id": "f6f40eb4-109b-42aa-a15b-6e745421daa1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8fe75e37-84cd-41ea-bfc2-d673bd4ff559",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5da45e31-8876-49a5-aaca-94fa388b87b9",
"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-11-08T10:31:46.3929533+00:00",
"date_create": "2026-11-08T10:31:46.3929533+00:00",
"date_update": "2026-11-08T10:31:46.3929533+00:00",
"updated_by_user_id": "f893a27a-f63c-4bae-8cfb-c3dc44c93748",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-08T10:31:46.3929533+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-11-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-08T10:31:46.3929533+00:00",
"date_last_job": "2026-11-08T10:31:46.3929533+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-08T10:31:46.3929533+00:00",
"modified_dateutc": "2026-11-08T10:31:46.3929533+00:00",
"is_mobile_installation": true
},
"job_type_id": "7baa321b-fda1-49dc-818e-04e7974ec613",
"job_type_code": "sample string 7",
"job_type": {
"id": "cea7d046-9fd9-42ea-a4fc-1bbaf23b241d",
"name": "sample string 2",
"sales_organization_id": "080ddad9-ecb2-4b63-8d20-3d56b6a75a41",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-08T10:31:46.3929533+00:00",
"code": "sample string 7"
},
"job_priority_id": "232719e9-ca88-4370-9425-917f14d84e8b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cbadb645-adb3-4027-ac4a-81670c70a497",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f17ef9ea-fe22-4cd1-8e22-2d31f7d940f6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1df4bd9c-8ea5-4ba9-9506-e15670624fab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9fed754-5812-4f80-a8cc-6cb704054868",
"db_currency_id": "7e0db183-97e7-449f-a28b-b878f7453c93",
"db_language_id": "82d62d3e-dbe0-4292-9b63-a6d4d2ac0900",
"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-11-08T10:31:46.3929533+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-08T10:31:46.3929533+00:00"
},
"job_status_id": "32523c82-9353-49ce-969f-30d9e80f9da1",
"job_status_code": "sample string 11",
"db_address_id": "599042a5-8a2b-4f49-ad52-cfc832b3b380",
"contact_id": "d16fb3b5-4d6e-4cf3-bc84-45bdc8d2b797",
"requested_by_company_id": "cacc4e24-1c40-4b11-a390-71c96f007e69",
"requested_by_contact_id": "bdb44850-14bd-46f7-9c8b-fdcd3692354e",
"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-11-08T10:31:46.3929533+00:00",
"due_date": "2026-11-08T10:31:46.3929533+00:00",
"date_create": "2026-11-08T10:31:46.3929533+00:00",
"date_update": "2026-11-08T10:31:46.3929533+00:00",
"date_closed": "2026-11-08T10:31:46.3929533+00:00",
"suggested_user_id": "7afe2250-5292-4718-8c4d-814b1129350b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1616c270-a2d8-4ade-83f9-f1607d5758df",
"db_language_id": "c133cd77-5a39-455e-9ac8-02440aaaccc1",
"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-11-08T10:31:46.3929533+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1f26d019-21b2-4c37-ace5-bd005b99146e",
"sales_organization": {
"id": "1df4bd9c-8ea5-4ba9-9506-e15670624fab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9fed754-5812-4f80-a8cc-6cb704054868",
"db_currency_id": "7e0db183-97e7-449f-a28b-b878f7453c93",
"db_language_id": "82d62d3e-dbe0-4292-9b63-a6d4d2ac0900",
"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-11-08T10:31:46.3929533+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "074148a8-fc71-4748-81b5-12ec499bf91c",
"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": "2eaa93c3-4289-4f44-a68c-a9fa5a38e43d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-08T10:31:46.3929533+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9b2864b9-22e4-4ef6-8ebf-3e1679fef361"
},
"suggested_date_start": "2026-11-08T10:31:46.3929533+00:00",
"skill_id": "9eb869bd-5421-45be-846e-0c203abcfb96",
"skill_code": "sample string 32",
"skill": {
"id": "b703aa6d-cad9-40d1-a6c2-38215111e3ba",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "233e3027-808b-406b-89df-27f98756e131",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1df4bd9c-8ea5-4ba9-9506-e15670624fab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9fed754-5812-4f80-a8cc-6cb704054868",
"db_currency_id": "7e0db183-97e7-449f-a28b-b878f7453c93",
"db_language_id": "82d62d3e-dbe0-4292-9b63-a6d4d2ac0900",
"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-11-08T10:31:46.3929533+00:00"
},
"modified_dateutc": "2026-11-08T10:31:46.3929533+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9fb7711d-a43f-4d11-8aec-dec5a4f6960b",
"date_reported_by_company": "2026-11-08T10:31:46.3929533+00:00",
"id2": 36,
"company_id": "51a3d2dc-f179-4490-b2ba-3a1c86962dca",
"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": "7ad69765-9d92-407b-aa84-0d9ca914a08f",
"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-11-08T10:31:46.3929533+00:00"
},
"work_instruction_details_id": "be33ccb5-c201-401b-bb8f-dc3113c07fee",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b9b92554-4124-42f7-94f5-e5007a7a0fb1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ea86d6d8-a25d-40ed-a025-70b787c2c90d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-08T10:31:46.3929533+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": "c51939b1-088c-4179-987a-423585b2cf87",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-08T10:31:46.3929533+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.