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": "fbd31dd5-837f-4d6c-9793-8ba16ba5cc6a",
"jobs_id": "c174522d-4546-45b8-9461-b0b8c89c7056",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f33bdca5-e047-4053-94bd-59e2202fe701",
"_parent_id": "ba25a790-682e-4b45-9829-4254a160ceed",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ee400142-331e-4f62-ae45-c6c412e68ced",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a363cc78-65bb-412a-ab21-08ebd18e57bd",
"_parent_id": "71bff1f8-79fc-4f32-81ea-340286b8c519",
"root_parent_id": "9abe9381-8a50-46eb-b994-9eea78e79f15",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ac8f0f62-138d-4721-b45f-3419bd7ab778",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0a989f03-383b-4176-879d-f7ec41ba7c1c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "39b12c9d-142d-46d6-b6d6-b8669a6d5e1b",
"_parent_code": "sample string 6",
"sales_organization_id": "cac70e58-0ba0-4826-8b5e-dc41219c7137",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5e197dc0-d63c-44b3-af9b-5a6829f3e749",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e846a9bc-0004-4c61-a063-d3338e9d65eb",
"db_currency_id": "d6a9d990-c3ef-4fcc-ad64-e25b47e1a735",
"db_language_id": "cc17e8ac-d0d0-448f-9cde-ebd0909868a3",
"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-08-29T11:49:51.5687045+00:00"
},
"modified_dateutc": "2026-08-29T11:49:51.5687045+00:00"
},
"equipment_model_id": "49f4d5ae-a544-4fce-b1cc-c812d5fb1f46",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "07a88f37-fe62-47db-b932-f74ba2ada0f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7c711b2f-0c6c-483b-a364-e216d816d2d2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a0c59a18-0156-4b04-b486-2384d4075b42",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "328f7bf1-fdc4-4de8-9fd0-d482497ea63c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5e197dc0-d63c-44b3-af9b-5a6829f3e749",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e846a9bc-0004-4c61-a063-d3338e9d65eb",
"db_currency_id": "d6a9d990-c3ef-4fcc-ad64-e25b47e1a735",
"db_language_id": "cc17e8ac-d0d0-448f-9cde-ebd0909868a3",
"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-08-29T11:49:51.5687045+00:00"
},
"modified_dateutc": "2026-08-29T11:49:51.5687045+00:00"
},
"equipment_family_id": "fe59ac2c-6028-4f92-a7df-adcbb47c3b6d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0a989f03-383b-4176-879d-f7ec41ba7c1c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "39b12c9d-142d-46d6-b6d6-b8669a6d5e1b",
"_parent_code": "sample string 6",
"sales_organization_id": "cac70e58-0ba0-4826-8b5e-dc41219c7137",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5e197dc0-d63c-44b3-af9b-5a6829f3e749",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e846a9bc-0004-4c61-a063-d3338e9d65eb",
"db_currency_id": "d6a9d990-c3ef-4fcc-ad64-e25b47e1a735",
"db_language_id": "cc17e8ac-d0d0-448f-9cde-ebd0909868a3",
"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-08-29T11:49:51.5687045+00:00"
},
"modified_dateutc": "2026-08-29T11:49:51.5687045+00:00"
},
"date_in_production_since": "2026-08-29T11:49:51.5687045+00:00",
"date_out_of_production_since": "2026-08-29T11:49:51.5687045+00:00",
"date_end_support": "2026-08-29T11:49:51.5687045+00:00",
"sales_organization_id": "462f6a51-906b-4b30-8bfe-f85e7aa28e2d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5e197dc0-d63c-44b3-af9b-5a6829f3e749",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e846a9bc-0004-4c61-a063-d3338e9d65eb",
"db_currency_id": "d6a9d990-c3ef-4fcc-ad64-e25b47e1a735",
"db_language_id": "cc17e8ac-d0d0-448f-9cde-ebd0909868a3",
"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-08-29T11:49:51.5687045+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-08-29T11:49:51.5687045+00:00"
},
"project_status_id": "11b74330-c00e-49e0-8673-33e75b9acff6",
"project_status_code": "sample string 10",
"project_status": {
"id": "948e7d9a-c542-425a-9cd8-87b1dc3ee85d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b45531fc-a29a-45b8-9fb0-8e267a62e70e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5e197dc0-d63c-44b3-af9b-5a6829f3e749",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e846a9bc-0004-4c61-a063-d3338e9d65eb",
"db_currency_id": "d6a9d990-c3ef-4fcc-ad64-e25b47e1a735",
"db_language_id": "cc17e8ac-d0d0-448f-9cde-ebd0909868a3",
"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-08-29T11:49:51.5687045+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T11:49:51.5687045+00:00"
},
"company_id": "9c820fe3-7226-4da0-8993-dc1206d090e3",
"company_code": "sample string 12",
"db_address_id": "d6a251ed-cbd3-4852-96f1-d02f20e8d6bb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "878502d7-b2ba-4cfd-915f-e18c544e3331",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a2201b1e-414e-4d81-9ec3-f25d36f9cfd4",
"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-08-29T11:49:51.5687045+00:00",
"date_create": "2026-08-29T11:49:51.5687045+00:00",
"date_update": "2026-08-29T11:49:51.5687045+00:00",
"updated_by_user_id": "7e77d998-ed8c-4c05-be70-702ba134ba09",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-29T11:49:51.5687045+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-08-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-29T11:49:51.5687045+00:00",
"date_last_job": "2026-08-29T11:49:51.5687045+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-29T11:49:51.5687045+00:00",
"modified_dateutc": "2026-08-29T11:49:51.5687045+00:00",
"is_mobile_installation": true
},
"job_type_id": "b107747e-6dc3-45c3-8b17-450c4c8b3d33",
"job_type_code": "sample string 7",
"job_type": {
"id": "6f482862-2a7d-446a-9fe3-706d4bc90b02",
"name": "sample string 2",
"sales_organization_id": "40459e91-903e-4b52-8614-95cb168ac46e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-29T11:49:51.5687045+00:00",
"code": "sample string 7"
},
"job_priority_id": "99ea76d4-d5d9-465b-967e-4a5921539d61",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "80115604-0d2e-49a8-af35-4553a7b03e90",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e7ba3b43-f211-4aed-b6ce-51792851ae5d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5e197dc0-d63c-44b3-af9b-5a6829f3e749",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e846a9bc-0004-4c61-a063-d3338e9d65eb",
"db_currency_id": "d6a9d990-c3ef-4fcc-ad64-e25b47e1a735",
"db_language_id": "cc17e8ac-d0d0-448f-9cde-ebd0909868a3",
"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-08-29T11:49:51.5687045+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T11:49:51.5687045+00:00"
},
"job_status_id": "cf4fbac8-2990-42ad-90dd-2426dddccf14",
"job_status_code": "sample string 11",
"db_address_id": "496ef51c-b8ea-4423-ad95-bc81014fdee4",
"contact_id": "31c190b6-08e5-4011-9b74-15ab5e7fc235",
"requested_by_company_id": "1715b756-06bf-4e7b-b9f5-5ad420ee76cc",
"requested_by_contact_id": "bc4a7d9e-4e41-47f8-a40d-04eb06838888",
"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-08-29T11:49:51.5687045+00:00",
"due_date": "2026-08-29T11:49:51.5687045+00:00",
"date_create": "2026-08-29T11:49:51.5687045+00:00",
"date_update": "2026-08-29T11:49:51.5687045+00:00",
"date_closed": "2026-08-29T11:49:51.5687045+00:00",
"suggested_user_id": "e5181421-a95b-42d9-8eab-37644b8ebd09",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1c0a15b5-9b92-4738-bf0c-20552369b6c7",
"db_language_id": "b348d9bc-ebb5-4779-a6ad-1ee370710e08",
"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-08-29T11:49:51.5687045+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7fc16bdb-0eed-4cc3-be90-1b5c9ee0ddce",
"sales_organization": {
"id": "5e197dc0-d63c-44b3-af9b-5a6829f3e749",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e846a9bc-0004-4c61-a063-d3338e9d65eb",
"db_currency_id": "d6a9d990-c3ef-4fcc-ad64-e25b47e1a735",
"db_language_id": "cc17e8ac-d0d0-448f-9cde-ebd0909868a3",
"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-08-29T11:49:51.5687045+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5449d10c-1d47-4b94-8463-3abeb38ff036",
"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": "5be80298-8652-4ba2-acb2-14284f2ec6ea",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-29T11:49:51.5687045+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0801df9d-8743-4891-a3f6-9eeb28c83c36"
},
"suggested_date_start": "2026-08-29T11:49:51.5687045+00:00",
"skill_id": "ff8ab34f-9ff5-41ee-b993-e1a11e40f820",
"skill_code": "sample string 32",
"skill": {
"id": "cc79aa69-b292-436b-8422-30ee548fa8fd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "747e2f0e-8f12-444a-ab60-ef48fac20fcf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5e197dc0-d63c-44b3-af9b-5a6829f3e749",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e846a9bc-0004-4c61-a063-d3338e9d65eb",
"db_currency_id": "d6a9d990-c3ef-4fcc-ad64-e25b47e1a735",
"db_language_id": "cc17e8ac-d0d0-448f-9cde-ebd0909868a3",
"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-08-29T11:49:51.5687045+00:00"
},
"modified_dateutc": "2026-08-29T11:49:51.5687045+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "79e0c413-3a84-4e96-be33-dc3132c03c33",
"date_reported_by_company": "2026-08-29T11:49:51.5687045+00:00",
"id2": 36,
"company_id": "2925e223-e636-4378-842a-1776b6a0efbe",
"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": "01b93657-774a-4f3d-9cc4-4d9327445385",
"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-08-29T11:49:51.5687045+00:00"
},
"work_instruction_details_id": "a35f3f62-3fef-4356-8881-90ecd01cc954",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b67d5e5c-379b-4f40-ad3d-fca64851b1c2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7e605cee-d7fe-4024-a8bc-7bde77098391",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-29T11:49:51.5687045+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": "7ef5cdba-470c-4034-8931-f00a937751a6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-29T11:49:51.5687045+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.