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": "93508784-70ba-4cb5-acee-5dcb3c68f71b",
"jobs_id": "098e2c77-3e20-4849-9c77-d873ef67866c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1f071621-0b94-4ff7-a0a5-5129650d1441",
"_parent_id": "84c90e26-cdc6-4d60-b312-21f77e636455",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ae273b94-240e-4616-a2e8-9f0a40eda934",
"project_reference_back_office": "sample string 5",
"project": {
"id": "14dbd826-8288-4992-a9b9-a4d6b92b7551",
"_parent_id": "cd01fdcb-e4e9-4a29-9c89-bd110406bf81",
"root_parent_id": "88f0c52f-5c67-4d87-9c08-f6dbfbe24fd3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6064ca1e-cfcb-4f6c-bfc1-13535e9d2efd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5b1cd872-22b7-41e5-ae8b-1dc24164153f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "09eb9b7c-323a-4f1f-862e-4ae0ddcfb4b6",
"_parent_code": "sample string 6",
"sales_organization_id": "a8b91620-5fbf-48ee-9897-263b1967d075",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d805fe55-be98-4b6e-afb7-9c49d9f18b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ef6d5e8-6701-4700-a074-6f7b8d8ce776",
"db_currency_id": "35c7921d-377b-4233-93d2-252c46327ba1",
"db_language_id": "dbd72746-6459-4fd3-a095-169c11729e41",
"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-04-13T09:22:53.7522799+00:00"
},
"modified_dateutc": "2026-04-13T09:22:53.7522799+00:00"
},
"equipment_model_id": "6575f5a5-3ef6-472c-a32d-8d3124aff6a4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "db8752ba-8da4-4e89-9844-12aa7d57156c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9d2524c4-f5ad-4cd0-b131-97a536eb6225",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bc118800-3374-4e96-90d0-f4d900ed1af3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8a5798da-46cc-4119-bb0a-a5dcf75fee2d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d805fe55-be98-4b6e-afb7-9c49d9f18b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ef6d5e8-6701-4700-a074-6f7b8d8ce776",
"db_currency_id": "35c7921d-377b-4233-93d2-252c46327ba1",
"db_language_id": "dbd72746-6459-4fd3-a095-169c11729e41",
"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-04-13T09:22:53.7522799+00:00"
},
"modified_dateutc": "2026-04-13T09:22:53.7522799+00:00"
},
"equipment_family_id": "1c278990-3a05-4bcd-9455-afcabe67669a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5b1cd872-22b7-41e5-ae8b-1dc24164153f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "09eb9b7c-323a-4f1f-862e-4ae0ddcfb4b6",
"_parent_code": "sample string 6",
"sales_organization_id": "a8b91620-5fbf-48ee-9897-263b1967d075",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d805fe55-be98-4b6e-afb7-9c49d9f18b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ef6d5e8-6701-4700-a074-6f7b8d8ce776",
"db_currency_id": "35c7921d-377b-4233-93d2-252c46327ba1",
"db_language_id": "dbd72746-6459-4fd3-a095-169c11729e41",
"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-04-13T09:22:53.7522799+00:00"
},
"modified_dateutc": "2026-04-13T09:22:53.7522799+00:00"
},
"date_in_production_since": "2026-04-13T09:22:53.7522799+00:00",
"date_out_of_production_since": "2026-04-13T09:22:53.7522799+00:00",
"date_end_support": "2026-04-13T09:22:53.7522799+00:00",
"sales_organization_id": "1fa35097-457b-4c67-8d17-6539dec6cb5a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d805fe55-be98-4b6e-afb7-9c49d9f18b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ef6d5e8-6701-4700-a074-6f7b8d8ce776",
"db_currency_id": "35c7921d-377b-4233-93d2-252c46327ba1",
"db_language_id": "dbd72746-6459-4fd3-a095-169c11729e41",
"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-04-13T09:22:53.7522799+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-04-13T09:22:53.7679402+00:00"
},
"project_status_id": "eb7746bd-55b2-4f12-9a19-57258223b04f",
"project_status_code": "sample string 10",
"project_status": {
"id": "c1c97b07-fcea-435a-bf8b-5797618b0356",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4ccc9b1e-c9c2-4b9d-952e-fe99397ec14c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d805fe55-be98-4b6e-afb7-9c49d9f18b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ef6d5e8-6701-4700-a074-6f7b8d8ce776",
"db_currency_id": "35c7921d-377b-4233-93d2-252c46327ba1",
"db_language_id": "dbd72746-6459-4fd3-a095-169c11729e41",
"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-04-13T09:22:53.7522799+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-13T09:22:53.7679402+00:00"
},
"company_id": "41c89cea-6976-49fb-8d9d-e995c6ecfa8c",
"company_code": "sample string 12",
"db_address_id": "6db9475e-df7a-472e-905d-6f2f196f01a8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "542d3d8a-5592-419a-9d76-6d3dac69ea4d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9c5e5bb8-0984-44ab-83db-26afb573b037",
"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-04-13T09:22:53.7679402+00:00",
"date_create": "2026-04-13T09:22:53.7679402+00:00",
"date_update": "2026-04-13T09:22:53.7679402+00:00",
"updated_by_user_id": "e01d2d15-ac37-476b-b0c7-ff98d9952c19",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-13T09:22:53.7679402+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-04-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-13T09:22:53.7679402+00:00",
"date_last_job": "2026-04-13T09:22:53.7679402+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-13T09:22:53.7679402+00:00",
"modified_dateutc": "2026-04-13T09:22:53.7679402+00:00",
"is_mobile_installation": true
},
"job_type_id": "d2019f6a-0125-42f0-a1f2-f21c99c029b3",
"job_type_code": "sample string 7",
"job_type": {
"id": "1aeadeaa-062a-4a30-9c1e-e542ea811201",
"name": "sample string 2",
"sales_organization_id": "8e08011b-ecc3-4325-9aa5-4fb4c28465d5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-13T09:22:53.7679402+00:00",
"code": "sample string 7"
},
"job_priority_id": "b2731018-a4aa-416a-9335-26b809e00bd9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fb505315-7958-44c9-9cc5-0978065466d3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2fc9b6b1-a185-42eb-a11c-741ac1211782",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d805fe55-be98-4b6e-afb7-9c49d9f18b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ef6d5e8-6701-4700-a074-6f7b8d8ce776",
"db_currency_id": "35c7921d-377b-4233-93d2-252c46327ba1",
"db_language_id": "dbd72746-6459-4fd3-a095-169c11729e41",
"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-04-13T09:22:53.7522799+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-13T09:22:53.7679402+00:00"
},
"job_status_id": "f34f35ee-ca45-49c4-aacd-1c960c52a064",
"job_status_code": "sample string 11",
"db_address_id": "72f7cb9f-94e3-4f0a-8f27-a91aae16945e",
"contact_id": "995adf00-17ec-4015-996a-6fd28585e5c6",
"requested_by_company_id": "d1294c36-2245-4776-9459-0f8efd86ad73",
"requested_by_contact_id": "59bcee69-07cf-45a2-8d62-7061929085c3",
"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-04-13T09:22:53.7679402+00:00",
"due_date": "2026-04-13T09:22:53.7679402+00:00",
"date_create": "2026-04-13T09:22:53.7679402+00:00",
"date_update": "2026-04-13T09:22:53.7679402+00:00",
"date_closed": "2026-04-13T09:22:53.7679402+00:00",
"suggested_user_id": "aa7f63ff-06f1-4c6e-8b6f-b0f8a089c920",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6eef6207-59ea-4956-9736-dbbc0d77fa46",
"db_language_id": "79454566-42e6-4990-8462-4e1b9f0c868f",
"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-04-13T09:22:53.7679402+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1a5b9d21-78ae-49f4-9732-397b4d519c38",
"sales_organization": {
"id": "d805fe55-be98-4b6e-afb7-9c49d9f18b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ef6d5e8-6701-4700-a074-6f7b8d8ce776",
"db_currency_id": "35c7921d-377b-4233-93d2-252c46327ba1",
"db_language_id": "dbd72746-6459-4fd3-a095-169c11729e41",
"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-04-13T09:22:53.7522799+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "232f2323-f6db-4e1a-9435-c34aa4d86c9c",
"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": "5dfb1efd-5d44-4834-b3b8-7ef126d2288f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-13T09:22:53.7679402+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2eba410d-81f4-42e8-8c02-ecc3473e09fc"
},
"suggested_date_start": "2026-04-13T09:22:53.7679402+00:00",
"skill_id": "9c9d7fd3-96a1-419c-a05b-3f10b44e59e3",
"skill_code": "sample string 32",
"skill": {
"id": "681b532a-1419-47ab-934c-ae1821b1fa36",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5c767cb6-6cf7-4e86-ab87-7c988f0f6240",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d805fe55-be98-4b6e-afb7-9c49d9f18b2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9ef6d5e8-6701-4700-a074-6f7b8d8ce776",
"db_currency_id": "35c7921d-377b-4233-93d2-252c46327ba1",
"db_language_id": "dbd72746-6459-4fd3-a095-169c11729e41",
"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-04-13T09:22:53.7522799+00:00"
},
"modified_dateutc": "2026-04-13T09:22:53.7679402+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "39e871fc-da03-40ef-932e-f07292ba1b82",
"date_reported_by_company": "2026-04-13T09:22:53.7679402+00:00",
"id2": 36,
"company_id": "31860db0-0521-429a-ba2a-30d57a14ce7a",
"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": "477b4120-8f0c-477c-a47c-db709829512d",
"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-04-13T09:22:53.7679402+00:00"
},
"work_instruction_details_id": "aabc5478-7a0f-4cfc-a69a-65192c915d8e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3fee2c97-b79e-41de-83a0-b29a48682359",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5577ca88-ccd7-48ae-9195-d9e11c09494c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-13T09:22:53.7679402+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": "a64822e6-081e-4103-9b24-ee0a687cbbdc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-13T09:22:53.7679402+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.