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": "ca7c01b2-06d4-46ad-879a-086d807132ad",
"jobs_id": "5d1db883-69c0-4d2e-a2ff-284b96e90ade",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "bd1fd0b0-f240-4199-ae26-b108c6248728",
"_parent_id": "5da96956-96ce-4da9-b9e6-752701f6e0f1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ea4e1039-be87-4f8a-b2b0-807d5ef34179",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bc359f78-112f-4c4a-ad52-9cd5b504829d",
"_parent_id": "4777fa4d-9ad5-4a17-be70-f5de2a89ed37",
"root_parent_id": "0ddbec12-b2ea-46aa-9f67-d68f88e460b9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0a5302bf-364d-4227-93ef-a3c561c5a2a6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "82d5d39d-e9aa-486b-aba6-9283a8ce3c80",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0f6e66e7-5765-4919-8285-e963c5378e11",
"_parent_code": "sample string 6",
"sales_organization_id": "82e96e29-0ce6-47b2-a9a0-5aa23dd0b256",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fba7319c-0a8f-4b0f-ab69-7358782d02f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6a6fc9-7f07-4cf4-a1f3-e232629f5401",
"db_currency_id": "114e4c15-e3b5-42bf-9f66-6d20b504303a",
"db_language_id": "9bfa2a3d-3db6-46c6-8430-196b53c9b907",
"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": "2025-12-22T19:23:48.2794093+00:00"
},
"modified_dateutc": "2025-12-22T19:23:48.2794093+00:00"
},
"equipment_model_id": "04d45a85-5be4-45e3-9a8a-052ad9a93b65",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "442330d9-b67c-4dc7-b4f2-9bb565d31822",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "321a2ee7-9c63-4bcb-912a-e4b286d36245",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bccef6f2-e9cf-417f-9b8c-9b746d0897a7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d0d97ad4-52d8-46ac-b492-bf8a7134da0e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fba7319c-0a8f-4b0f-ab69-7358782d02f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6a6fc9-7f07-4cf4-a1f3-e232629f5401",
"db_currency_id": "114e4c15-e3b5-42bf-9f66-6d20b504303a",
"db_language_id": "9bfa2a3d-3db6-46c6-8430-196b53c9b907",
"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": "2025-12-22T19:23:48.2794093+00:00"
},
"modified_dateutc": "2025-12-22T19:23:48.2794093+00:00"
},
"equipment_family_id": "6c5a60d3-d0af-4af0-aae5-0972b9580e0d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "82d5d39d-e9aa-486b-aba6-9283a8ce3c80",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0f6e66e7-5765-4919-8285-e963c5378e11",
"_parent_code": "sample string 6",
"sales_organization_id": "82e96e29-0ce6-47b2-a9a0-5aa23dd0b256",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fba7319c-0a8f-4b0f-ab69-7358782d02f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6a6fc9-7f07-4cf4-a1f3-e232629f5401",
"db_currency_id": "114e4c15-e3b5-42bf-9f66-6d20b504303a",
"db_language_id": "9bfa2a3d-3db6-46c6-8430-196b53c9b907",
"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": "2025-12-22T19:23:48.2794093+00:00"
},
"modified_dateutc": "2025-12-22T19:23:48.2794093+00:00"
},
"date_in_production_since": "2025-12-22T19:23:48.2794093+00:00",
"date_out_of_production_since": "2025-12-22T19:23:48.2794093+00:00",
"date_end_support": "2025-12-22T19:23:48.2794093+00:00",
"sales_organization_id": "4c7427b7-a4e0-4725-991b-827fe1ef823e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fba7319c-0a8f-4b0f-ab69-7358782d02f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6a6fc9-7f07-4cf4-a1f3-e232629f5401",
"db_currency_id": "114e4c15-e3b5-42bf-9f66-6d20b504303a",
"db_language_id": "9bfa2a3d-3db6-46c6-8430-196b53c9b907",
"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": "2025-12-22T19:23:48.2794093+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": "2025-12-22T19:23:48.2794093+00:00"
},
"project_status_id": "4d30b2c6-d344-44a2-9040-7fede1adc4af",
"project_status_code": "sample string 10",
"project_status": {
"id": "4f5c094a-d558-4190-9f2c-b752c75c56f6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b7d59911-b7e0-4ebf-bd13-2f22379cca26",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fba7319c-0a8f-4b0f-ab69-7358782d02f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6a6fc9-7f07-4cf4-a1f3-e232629f5401",
"db_currency_id": "114e4c15-e3b5-42bf-9f66-6d20b504303a",
"db_language_id": "9bfa2a3d-3db6-46c6-8430-196b53c9b907",
"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": "2025-12-22T19:23:48.2794093+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-22T19:23:48.2794093+00:00"
},
"company_id": "d3f4c4e3-38c8-4103-8a67-5a56b3b302b2",
"company_code": "sample string 12",
"db_address_id": "4245bdd9-a6b3-404d-83e8-f2c237cb105e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5061fd7a-e141-4fbc-a01e-9776d0e38034",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fa59569d-72a1-4fd6-8566-12e1d45360e7",
"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": "2025-12-22T19:23:48.2794093+00:00",
"date_create": "2025-12-22T19:23:48.2794093+00:00",
"date_update": "2025-12-22T19:23:48.2794093+00:00",
"updated_by_user_id": "a740db7e-da37-4f61-89c3-d56e491fb1c5",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-22T19:23:48.2794093+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": "2025-12-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-22T19:23:48.2794093+00:00",
"date_last_job": "2025-12-22T19:23:48.2794093+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-22T19:23:48.2794093+00:00",
"modified_dateutc": "2025-12-22T19:23:48.2794093+00:00",
"is_mobile_installation": true
},
"job_type_id": "f02d7ad7-2c10-40b2-83ed-12fe6be0d706",
"job_type_code": "sample string 7",
"job_type": {
"id": "b9a1afa3-c80a-4e57-b9b8-c68f2f3f6be5",
"name": "sample string 2",
"sales_organization_id": "7af94f1b-45c6-4167-a1a2-c8b75b375f4d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-22T19:23:48.2794093+00:00",
"code": "sample string 7"
},
"job_priority_id": "25699b2b-dbaf-4bc8-abe8-9628d59de23c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1b0bb55a-3126-48d7-8c01-483da84dbaf5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f794faaf-2319-4869-ba92-88558b623f1a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fba7319c-0a8f-4b0f-ab69-7358782d02f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6a6fc9-7f07-4cf4-a1f3-e232629f5401",
"db_currency_id": "114e4c15-e3b5-42bf-9f66-6d20b504303a",
"db_language_id": "9bfa2a3d-3db6-46c6-8430-196b53c9b907",
"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": "2025-12-22T19:23:48.2794093+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-22T19:23:48.2794093+00:00"
},
"job_status_id": "f21e373e-aa88-4503-9a33-fe24f6e3e4df",
"job_status_code": "sample string 11",
"db_address_id": "2ac0c6ea-d1fc-425a-b867-a22688181c02",
"contact_id": "fa204ee0-aeca-4e90-802c-a42fb50fa7e7",
"requested_by_company_id": "7294d73c-efa8-470a-a0ab-4c2747bca951",
"requested_by_contact_id": "d289ecde-31af-461a-896a-178b32537d66",
"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": "2025-12-22T19:23:48.2794093+00:00",
"due_date": "2025-12-22T19:23:48.2794093+00:00",
"date_create": "2025-12-22T19:23:48.2794093+00:00",
"date_update": "2025-12-22T19:23:48.2794093+00:00",
"date_closed": "2025-12-22T19:23:48.2794093+00:00",
"suggested_user_id": "19cdaa18-a010-472b-b265-5bb5a6624eae",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "69af24c6-d8bd-4e0d-a9f3-882deec9d9b1",
"db_language_id": "1d1fbffe-5232-428a-b71e-f91ab780c97c",
"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": "2025-12-22T19:23:48.2794093+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "820ae040-6100-4e00-8407-364dca7a3057",
"sales_organization": {
"id": "fba7319c-0a8f-4b0f-ab69-7358782d02f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6a6fc9-7f07-4cf4-a1f3-e232629f5401",
"db_currency_id": "114e4c15-e3b5-42bf-9f66-6d20b504303a",
"db_language_id": "9bfa2a3d-3db6-46c6-8430-196b53c9b907",
"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": "2025-12-22T19:23:48.2794093+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f114164e-e979-4e2e-b792-7549d81fdf64",
"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": "d025dc29-857e-41e9-ad96-8f0bba420192",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-22T19:23:48.2794093+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b3f02627-77e3-4977-b380-73409ac8add1"
},
"suggested_date_start": "2025-12-22T19:23:48.2794093+00:00",
"skill_id": "90113037-a759-4aef-ac41-1e3cdc32beb1",
"skill_code": "sample string 32",
"skill": {
"id": "a54733c9-47a6-418b-baa7-e21f4855e3aa",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "82d78829-c2c1-4050-97d1-d3a04bdc81f0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fba7319c-0a8f-4b0f-ab69-7358782d02f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7d6a6fc9-7f07-4cf4-a1f3-e232629f5401",
"db_currency_id": "114e4c15-e3b5-42bf-9f66-6d20b504303a",
"db_language_id": "9bfa2a3d-3db6-46c6-8430-196b53c9b907",
"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": "2025-12-22T19:23:48.2794093+00:00"
},
"modified_dateutc": "2025-12-22T19:23:48.2794093+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3b39c523-6218-4dd6-8873-1d8ddda0ad22",
"date_reported_by_company": "2025-12-22T19:23:48.2794093+00:00",
"id2": 36,
"company_id": "daf46919-58cc-4a91-a1ec-66a69731a97c",
"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": "3c5fb885-81b9-45b4-b873-534bae2482c2",
"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": "2025-12-22T19:23:48.2794093+00:00"
},
"work_instruction_details_id": "21cfdd5e-f7e2-4b7e-8472-44022c2ad8fa",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ab03bf6a-95a9-4be2-b5ca-f69a556b9de2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "44f225fe-e16c-4775-8913-6d6a2afd5a94",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-22T19:23:48.2794093+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": "40639927-0cfb-460d-a7d2-69a1e49bfae8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-22T19:23:48.2794093+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.