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": "974ffaed-5f6c-4b53-ae60-0f581c5ff380",
"jobs_id": "d92ae9e6-91a1-4d3a-8813-f2d67f7a8954",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5d09ce8d-8289-44ec-946a-c5ee911fc13d",
"_parent_id": "6c63a1e8-db3d-44e2-8eda-bf0d93e3ccae",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b2f6fc60-6c69-4057-b59c-3df4277e3bb2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ab312f5e-d764-4db9-a70d-216779938467",
"_parent_id": "34b5818d-74d9-4f45-9488-e780dc4eff6a",
"root_parent_id": "67cb510a-3adb-42b4-953d-7d2b6dcf549b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "77c89bf8-3fee-4673-8e42-3d3b3c2f4fa9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "46dda543-e733-4a13-a4e7-75c3a8df98a3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "489c84ba-e194-4b6f-bed6-611990c9b3b8",
"_parent_code": "sample string 6",
"sales_organization_id": "112e903f-5eb4-46e4-be34-6e66b19bb634",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed0a018f-bfc4-451b-a327-f22399ce7d4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dd9488a-f01c-49c7-a42e-5c8648fcb3c1",
"db_currency_id": "361696df-816d-4b2f-8575-96795cd1601f",
"db_language_id": "23e389bb-4171-4f83-866b-7351a8a2558a",
"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-09-04T13:21:31.1695585+00:00"
},
"modified_dateutc": "2026-09-04T13:21:31.1695585+00:00"
},
"equipment_model_id": "33a8f56e-4019-4f6d-ab2f-85f27ff4211b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8167232e-34dd-445d-be79-9e4b183992e7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f87f5ba6-781e-4943-8b64-e2c2d0a78615",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2b058d10-991a-43b5-bc9b-65f542bbbc90",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5cd36a72-9cc1-44af-b3b2-9d8f6fd72cc8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ed0a018f-bfc4-451b-a327-f22399ce7d4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dd9488a-f01c-49c7-a42e-5c8648fcb3c1",
"db_currency_id": "361696df-816d-4b2f-8575-96795cd1601f",
"db_language_id": "23e389bb-4171-4f83-866b-7351a8a2558a",
"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-09-04T13:21:31.1695585+00:00"
},
"modified_dateutc": "2026-09-04T13:21:31.1695585+00:00"
},
"equipment_family_id": "cc47d884-1b1c-46cd-b2ae-7662bdfa2530",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "46dda543-e733-4a13-a4e7-75c3a8df98a3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "489c84ba-e194-4b6f-bed6-611990c9b3b8",
"_parent_code": "sample string 6",
"sales_organization_id": "112e903f-5eb4-46e4-be34-6e66b19bb634",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ed0a018f-bfc4-451b-a327-f22399ce7d4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dd9488a-f01c-49c7-a42e-5c8648fcb3c1",
"db_currency_id": "361696df-816d-4b2f-8575-96795cd1601f",
"db_language_id": "23e389bb-4171-4f83-866b-7351a8a2558a",
"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-09-04T13:21:31.1695585+00:00"
},
"modified_dateutc": "2026-09-04T13:21:31.1695585+00:00"
},
"date_in_production_since": "2026-09-04T13:21:31.1695585+00:00",
"date_out_of_production_since": "2026-09-04T13:21:31.1695585+00:00",
"date_end_support": "2026-09-04T13:21:31.1695585+00:00",
"sales_organization_id": "d501f6e7-82e6-47d0-a200-0f4d3970a93f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ed0a018f-bfc4-451b-a327-f22399ce7d4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dd9488a-f01c-49c7-a42e-5c8648fcb3c1",
"db_currency_id": "361696df-816d-4b2f-8575-96795cd1601f",
"db_language_id": "23e389bb-4171-4f83-866b-7351a8a2558a",
"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-09-04T13:21:31.1695585+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-09-04T13:21:31.1695585+00:00"
},
"project_status_id": "68906044-f74e-4415-b7a2-628811f81d26",
"project_status_code": "sample string 10",
"project_status": {
"id": "47bc8827-da6b-46fa-96ef-b0b9c077c85f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d485e215-53ac-4d4b-a7ba-e50620a76fb5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed0a018f-bfc4-451b-a327-f22399ce7d4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dd9488a-f01c-49c7-a42e-5c8648fcb3c1",
"db_currency_id": "361696df-816d-4b2f-8575-96795cd1601f",
"db_language_id": "23e389bb-4171-4f83-866b-7351a8a2558a",
"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-09-04T13:21:31.1695585+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T13:21:31.1695585+00:00"
},
"company_id": "d4a194b6-6fd9-47d1-b902-7ab06566cc3b",
"company_code": "sample string 12",
"db_address_id": "735c2ab6-8d99-4cb4-9d89-754147dcc0ae",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ce228f27-3a64-4c2b-a5a7-ada0441233ff",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6c550af1-dec2-4f4f-be79-1eafd2af82eb",
"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-09-04T13:21:31.1695585+00:00",
"date_create": "2026-09-04T13:21:31.1695585+00:00",
"date_update": "2026-09-04T13:21:31.1695585+00:00",
"updated_by_user_id": "c049ad87-a85c-4a59-91eb-a350114d3f25",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-04T13:21:31.1695585+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-09-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-04T13:21:31.1695585+00:00",
"date_last_job": "2026-09-04T13:21:31.1695585+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-04T13:21:31.1695585+00:00",
"modified_dateutc": "2026-09-04T13:21:31.1695585+00:00",
"is_mobile_installation": true
},
"job_type_id": "68956e68-4dca-4fbe-b072-e9340dcef096",
"job_type_code": "sample string 7",
"job_type": {
"id": "17778b72-a8ad-4236-956d-548eb23c45c6",
"name": "sample string 2",
"sales_organization_id": "25f69400-4541-405b-9568-07bf7d90f81c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-04T13:21:31.1695585+00:00",
"code": "sample string 7"
},
"job_priority_id": "6b687b3a-891c-4496-943f-9bf385bd6965",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "70cb0fec-310a-485c-af5a-b8ca611799ac",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "93863ddb-2d3e-4fb3-acec-7b62c86b2786",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed0a018f-bfc4-451b-a327-f22399ce7d4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dd9488a-f01c-49c7-a42e-5c8648fcb3c1",
"db_currency_id": "361696df-816d-4b2f-8575-96795cd1601f",
"db_language_id": "23e389bb-4171-4f83-866b-7351a8a2558a",
"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-09-04T13:21:31.1695585+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T13:21:31.1695585+00:00"
},
"job_status_id": "190f97ce-f65c-4dae-8ee8-0e889834187b",
"job_status_code": "sample string 11",
"db_address_id": "473660c7-d917-4f6e-bc96-dfda468bc11a",
"contact_id": "082f0e09-944f-4538-92b4-473622393e69",
"requested_by_company_id": "3451273e-a6ed-417a-ac03-6caf2e517457",
"requested_by_contact_id": "967f0625-ba37-45f2-9985-9071fa83ad98",
"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-09-04T13:21:31.1695585+00:00",
"due_date": "2026-09-04T13:21:31.1695585+00:00",
"date_create": "2026-09-04T13:21:31.1695585+00:00",
"date_update": "2026-09-04T13:21:31.1695585+00:00",
"date_closed": "2026-09-04T13:21:31.1695585+00:00",
"suggested_user_id": "9a8283df-dc38-4cc6-b80f-0b660cc0bdce",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bf64cde4-1ec8-4b06-b61c-4ed43260d41c",
"db_language_id": "139951dd-f920-4def-a5b7-d37105591afc",
"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-09-04T13:21:31.1695585+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a3880c41-b62b-4885-80e9-ae11f2dc07ed",
"sales_organization": {
"id": "ed0a018f-bfc4-451b-a327-f22399ce7d4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dd9488a-f01c-49c7-a42e-5c8648fcb3c1",
"db_currency_id": "361696df-816d-4b2f-8575-96795cd1601f",
"db_language_id": "23e389bb-4171-4f83-866b-7351a8a2558a",
"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-09-04T13:21:31.1695585+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ed0f4c0a-f3ad-41e3-972c-cb880af02fb6",
"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": "3ebe6139-cae7-49c3-8c08-8590d8f51bf1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-04T13:21:31.1695585+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "21f4f7a3-b8f0-4aa9-8673-8553d0329aab"
},
"suggested_date_start": "2026-09-04T13:21:31.1695585+00:00",
"skill_id": "2270665b-6e98-4a2e-b931-971e3664b343",
"skill_code": "sample string 32",
"skill": {
"id": "73d978a3-cfc1-4e47-889f-662e004ef491",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "82933f29-4257-490b-9d97-2566f5a132e7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ed0a018f-bfc4-451b-a327-f22399ce7d4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4dd9488a-f01c-49c7-a42e-5c8648fcb3c1",
"db_currency_id": "361696df-816d-4b2f-8575-96795cd1601f",
"db_language_id": "23e389bb-4171-4f83-866b-7351a8a2558a",
"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-09-04T13:21:31.1695585+00:00"
},
"modified_dateutc": "2026-09-04T13:21:31.1695585+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3b88e29c-9c05-46ae-8117-f8fbe153311e",
"date_reported_by_company": "2026-09-04T13:21:31.1695585+00:00",
"id2": 36,
"company_id": "118967c3-c650-42cb-b64d-6b86f56d6c52",
"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": "774bdbfd-7e01-4d1f-9c6b-0e199bd81946",
"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-09-04T13:21:31.1695585+00:00"
},
"work_instruction_details_id": "b61a0f58-bc84-4167-a982-f2769a8f1c0c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e3369ff0-2c71-4c4e-88d8-fe2a47c3af6f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "411b9087-4d3a-474a-b3e0-e599376c30ef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-04T13:21:31.1695585+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": "26fe4a0e-151b-49a9-9478-828bb29acb44",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-04T13:21:31.1695585+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.