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": "e6e0e3a3-6696-4192-8f51-6e83fbd38da2",
"jobs_id": "1c3750a6-2581-441b-a0d8-22b90ba0e6f9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "277a830a-0624-479c-9baa-5e9562c89cf8",
"_parent_id": "310c6a89-6cd5-4208-a4e7-de81a6e2df35",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ac3f87b6-da99-4c3b-822c-13388cd26b86",
"project_reference_back_office": "sample string 5",
"project": {
"id": "351e5900-c69d-4282-b916-04306e1bf4b7",
"_parent_id": "4570bd02-4d1d-4d2e-a74d-9aca395058c2",
"root_parent_id": "d83eccaf-1c86-4caf-8e04-39177f007b21",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c2f13b07-52f5-481c-aec6-814067e36fd0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b99cf834-3b42-4f28-8369-1b066e226a07",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9ee726c6-397a-4494-a9fc-1e2def176e94",
"_parent_code": "sample string 6",
"sales_organization_id": "abc89efb-07cd-4cef-89e4-c1a463fd7bdd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "613593a1-d966-4686-8cb3-5236eaf0c72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6be219c-ff62-40c1-93ae-61d49366c7b2",
"db_currency_id": "3ce95391-d2cf-47d7-aa41-87b391beda64",
"db_language_id": "bbc2b39b-6d2e-45c5-90dd-5733721a4b27",
"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-20T10:22:57.1940703+00:00"
},
"modified_dateutc": "2026-08-20T10:22:57.1940703+00:00"
},
"equipment_model_id": "8553f716-e8cf-42ad-83f3-32d527796d48",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0a7d8017-6a7a-4ffc-8fbf-e4d91bd36b33",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1c412be0-06e8-4506-bf1b-352f19552b4e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "11b518ca-78bf-4cb7-b1a8-0c467fee0a40",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "028e01ca-b30d-4afc-aba8-08261bb33682",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "613593a1-d966-4686-8cb3-5236eaf0c72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6be219c-ff62-40c1-93ae-61d49366c7b2",
"db_currency_id": "3ce95391-d2cf-47d7-aa41-87b391beda64",
"db_language_id": "bbc2b39b-6d2e-45c5-90dd-5733721a4b27",
"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-20T10:22:57.1940703+00:00"
},
"modified_dateutc": "2026-08-20T10:22:57.1940703+00:00"
},
"equipment_family_id": "ea98b9b4-7ba7-4411-919d-fe1f388f267b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b99cf834-3b42-4f28-8369-1b066e226a07",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9ee726c6-397a-4494-a9fc-1e2def176e94",
"_parent_code": "sample string 6",
"sales_organization_id": "abc89efb-07cd-4cef-89e4-c1a463fd7bdd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "613593a1-d966-4686-8cb3-5236eaf0c72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6be219c-ff62-40c1-93ae-61d49366c7b2",
"db_currency_id": "3ce95391-d2cf-47d7-aa41-87b391beda64",
"db_language_id": "bbc2b39b-6d2e-45c5-90dd-5733721a4b27",
"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-20T10:22:57.1940703+00:00"
},
"modified_dateutc": "2026-08-20T10:22:57.1940703+00:00"
},
"date_in_production_since": "2026-08-20T10:22:57.1940703+00:00",
"date_out_of_production_since": "2026-08-20T10:22:57.1940703+00:00",
"date_end_support": "2026-08-20T10:22:57.1940703+00:00",
"sales_organization_id": "2e856a20-f339-48de-9aa6-cd618f4ee28d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "613593a1-d966-4686-8cb3-5236eaf0c72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6be219c-ff62-40c1-93ae-61d49366c7b2",
"db_currency_id": "3ce95391-d2cf-47d7-aa41-87b391beda64",
"db_language_id": "bbc2b39b-6d2e-45c5-90dd-5733721a4b27",
"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-20T10:22:57.1940703+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-20T10:22:57.1940703+00:00"
},
"project_status_id": "0a434eff-7a2d-4305-bba0-266173fc56a3",
"project_status_code": "sample string 10",
"project_status": {
"id": "d358c23d-78dc-44d0-ae69-e4fd045e1261",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6cab4028-dab0-4553-9c7e-10aa541a0669",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "613593a1-d966-4686-8cb3-5236eaf0c72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6be219c-ff62-40c1-93ae-61d49366c7b2",
"db_currency_id": "3ce95391-d2cf-47d7-aa41-87b391beda64",
"db_language_id": "bbc2b39b-6d2e-45c5-90dd-5733721a4b27",
"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-20T10:22:57.1940703+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-20T10:22:57.1940703+00:00"
},
"company_id": "d3238432-a4ba-43de-8f4f-5827d67b5aed",
"company_code": "sample string 12",
"db_address_id": "58c497bc-c7c0-4206-80da-e84aa98c7430",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "28a96b6a-1de4-4491-ba03-15cda0c7a379",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f26753c5-1cb0-4c80-8356-849c527f9598",
"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-20T10:22:57.1940703+00:00",
"date_create": "2026-08-20T10:22:57.1940703+00:00",
"date_update": "2026-08-20T10:22:57.1940703+00:00",
"updated_by_user_id": "913d15a1-25e9-40c6-8dc8-af177c518213",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-20T10:22:57.1940703+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-20T10:22:57.1940703+00:00",
"date_last_job": "2026-08-20T10:22:57.1940703+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-20T10:22:57.1940703+00:00",
"modified_dateutc": "2026-08-20T10:22:57.1940703+00:00",
"is_mobile_installation": true
},
"job_type_id": "09b9237d-2cde-4227-9a14-92ad20f37924",
"job_type_code": "sample string 7",
"job_type": {
"id": "e3d2f5b8-14a8-43fe-8c1b-6e7b6e112da4",
"name": "sample string 2",
"sales_organization_id": "ccba7b6b-39ac-45ad-825d-e1173162aa21",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-20T10:22:57.1940703+00:00",
"code": "sample string 7"
},
"job_priority_id": "b3fbd237-cce0-4857-aa11-0c16d881a37a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "502503c2-7e0f-4792-82de-716609ccaf70",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b331ba0e-04e4-4906-a762-b0411234ad67",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "613593a1-d966-4686-8cb3-5236eaf0c72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6be219c-ff62-40c1-93ae-61d49366c7b2",
"db_currency_id": "3ce95391-d2cf-47d7-aa41-87b391beda64",
"db_language_id": "bbc2b39b-6d2e-45c5-90dd-5733721a4b27",
"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-20T10:22:57.1940703+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-20T10:22:57.1940703+00:00"
},
"job_status_id": "e8d86788-c0bf-4ea2-9518-a1d1a0560c86",
"job_status_code": "sample string 11",
"db_address_id": "f251d754-1ed8-4cb9-9410-c321b3077eed",
"contact_id": "88f58d32-3655-42c5-8bd2-ddf06aa1ff4d",
"requested_by_company_id": "4160d51e-9cf6-4996-a592-418817b77950",
"requested_by_contact_id": "f35b473e-d698-42e3-9b48-dcdccd682827",
"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-20T10:22:57.1940703+00:00",
"due_date": "2026-08-20T10:22:57.1940703+00:00",
"date_create": "2026-08-20T10:22:57.1940703+00:00",
"date_update": "2026-08-20T10:22:57.1940703+00:00",
"date_closed": "2026-08-20T10:22:57.1940703+00:00",
"suggested_user_id": "7da32e66-30d9-4777-913e-cf8f39fa0315",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "94b1b2fd-050a-4aa2-9cc1-6c8bd4e822c8",
"db_language_id": "ad90ef56-8786-48ac-ae79-8dea0e9dca32",
"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-20T10:22:57.1940703+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "80be6a73-cdfb-4ae5-a047-197b9178126d",
"sales_organization": {
"id": "613593a1-d966-4686-8cb3-5236eaf0c72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6be219c-ff62-40c1-93ae-61d49366c7b2",
"db_currency_id": "3ce95391-d2cf-47d7-aa41-87b391beda64",
"db_language_id": "bbc2b39b-6d2e-45c5-90dd-5733721a4b27",
"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-20T10:22:57.1940703+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d63343c8-a3b5-4a3b-8484-03e5c2a37984",
"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": "5f48b4e1-daeb-4cba-a102-60e6f1761ee5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-20T10:22:57.1940703+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3e7d52f1-0419-4799-84ae-e09205f76d8e"
},
"suggested_date_start": "2026-08-20T10:22:57.1940703+00:00",
"skill_id": "ac8e6a61-ffaf-4c5b-9632-2b899486a20b",
"skill_code": "sample string 32",
"skill": {
"id": "079fe2a6-8f6b-48cb-ac4d-c1c380de294d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0c245f89-8f95-4099-bea0-0810655c52b4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "613593a1-d966-4686-8cb3-5236eaf0c72c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6be219c-ff62-40c1-93ae-61d49366c7b2",
"db_currency_id": "3ce95391-d2cf-47d7-aa41-87b391beda64",
"db_language_id": "bbc2b39b-6d2e-45c5-90dd-5733721a4b27",
"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-20T10:22:57.1940703+00:00"
},
"modified_dateutc": "2026-08-20T10:22:57.1940703+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "81373fa6-0257-42a3-b8d6-03f6e31723e6",
"date_reported_by_company": "2026-08-20T10:22:57.1940703+00:00",
"id2": 36,
"company_id": "6dd58dae-2b75-4330-a3ae-e955606c031a",
"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": "df6bd6c5-8eee-4247-8a17-bb0c97a2d60e",
"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-20T10:22:57.1940703+00:00"
},
"work_instruction_details_id": "1f8779e8-20a2-4940-9d79-8e575690bfa1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fbf3e39f-95f3-4049-bd37-9628de868fb1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7cc740e7-9521-4ff1-b1d6-a960d14ef399",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-20T10:22:57.1940703+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": "dd2fed69-2946-4785-ad9b-391619e1644e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-20T10:22:57.1940703+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.