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": "befc9f78-98db-4760-bf36-6933b40969a8",
"jobs_id": "c495702d-ecb2-4cf3-a828-e755f70fffa3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6ff16f74-2544-49e9-8590-698e810d29be",
"_parent_id": "0041b447-5c8c-4325-bf9b-e45ab4671a1a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "254165a7-8a47-4636-ac1a-694897db5ba6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a0c51889-cba8-4ec8-a484-e47cf99b5478",
"_parent_id": "9a049215-6035-45bf-8c43-126f4cd4b3a7",
"root_parent_id": "9722d2af-6cdd-4f25-a006-8cca96a77fc2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e4b5562a-4508-4960-8ae5-89f282b59b86",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "63f2ae77-c8a2-4aa0-8ed3-a66c9becb21b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "63a4e4c1-2a67-432a-8436-edd3b9d8a35f",
"_parent_code": "sample string 6",
"sales_organization_id": "37aa96d3-48a3-4107-b784-9a0512576fd3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "90a864d3-07b0-462a-9c43-07bc3a6f11d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42b2193c-bf39-444b-8092-aae707acb13d",
"db_currency_id": "24e8154d-4662-44fb-8e9f-7a4a80e4c9e5",
"db_language_id": "7d8b2d63-a56e-499f-9dc2-4bef9ef3bd7c",
"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-20T11:20:00.8090761+00:00"
},
"modified_dateutc": "2026-08-20T11:20:00.8090761+00:00"
},
"equipment_model_id": "237bb359-1040-4008-93dd-81b81f41cd6c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "dfe8e268-ffe1-40e1-acc5-57b9ae83a585",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4f12252b-75fe-4091-b498-bce92fab226b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2b03fd07-a852-43a6-93b2-354122905e8b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b5c87cb0-066f-41b8-8b0d-04f06701e4ca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "90a864d3-07b0-462a-9c43-07bc3a6f11d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42b2193c-bf39-444b-8092-aae707acb13d",
"db_currency_id": "24e8154d-4662-44fb-8e9f-7a4a80e4c9e5",
"db_language_id": "7d8b2d63-a56e-499f-9dc2-4bef9ef3bd7c",
"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-20T11:20:00.8090761+00:00"
},
"modified_dateutc": "2026-08-20T11:20:00.8090761+00:00"
},
"equipment_family_id": "07917b30-a009-4ba7-a619-f4ab3c021d4a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "63f2ae77-c8a2-4aa0-8ed3-a66c9becb21b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "63a4e4c1-2a67-432a-8436-edd3b9d8a35f",
"_parent_code": "sample string 6",
"sales_organization_id": "37aa96d3-48a3-4107-b784-9a0512576fd3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "90a864d3-07b0-462a-9c43-07bc3a6f11d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42b2193c-bf39-444b-8092-aae707acb13d",
"db_currency_id": "24e8154d-4662-44fb-8e9f-7a4a80e4c9e5",
"db_language_id": "7d8b2d63-a56e-499f-9dc2-4bef9ef3bd7c",
"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-20T11:20:00.8090761+00:00"
},
"modified_dateutc": "2026-08-20T11:20:00.8090761+00:00"
},
"date_in_production_since": "2026-08-20T11:20:00.8090761+00:00",
"date_out_of_production_since": "2026-08-20T11:20:00.8090761+00:00",
"date_end_support": "2026-08-20T11:20:00.8090761+00:00",
"sales_organization_id": "d57bb4a3-7d4d-44c8-ba8f-fe204deb48b6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "90a864d3-07b0-462a-9c43-07bc3a6f11d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42b2193c-bf39-444b-8092-aae707acb13d",
"db_currency_id": "24e8154d-4662-44fb-8e9f-7a4a80e4c9e5",
"db_language_id": "7d8b2d63-a56e-499f-9dc2-4bef9ef3bd7c",
"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-20T11:20:00.8090761+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-20T11:20:00.8090761+00:00"
},
"project_status_id": "a722e535-6dbf-4c80-b71b-20dc738fa602",
"project_status_code": "sample string 10",
"project_status": {
"id": "e5bef916-77e8-4bbf-81a8-e41062b8042a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9e8da1ec-83f8-424a-8e5e-5734374dd06d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "90a864d3-07b0-462a-9c43-07bc3a6f11d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42b2193c-bf39-444b-8092-aae707acb13d",
"db_currency_id": "24e8154d-4662-44fb-8e9f-7a4a80e4c9e5",
"db_language_id": "7d8b2d63-a56e-499f-9dc2-4bef9ef3bd7c",
"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-20T11:20:00.8090761+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-20T11:20:00.8090761+00:00"
},
"company_id": "17538795-8a2d-4585-a6b3-3791e4317e6b",
"company_code": "sample string 12",
"db_address_id": "1a12c3d4-6689-4a3b-a808-8aa3dde3cc0d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a92783a0-d9a7-40a3-b7d9-730fa062e7ad",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "388481ef-8218-4606-a9ea-d272c6852736",
"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-20T11:20:00.8090761+00:00",
"date_create": "2026-08-20T11:20:00.8090761+00:00",
"date_update": "2026-08-20T11:20:00.8090761+00:00",
"updated_by_user_id": "570b668b-e1c2-4534-ba57-51a0a0b97a77",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-20T11:20:00.8090761+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-20T11:20:00.8090761+00:00",
"date_last_job": "2026-08-20T11:20:00.8090761+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-20T11:20:00.8090761+00:00",
"modified_dateutc": "2026-08-20T11:20:00.8090761+00:00",
"is_mobile_installation": true
},
"job_type_id": "50878450-b948-47f6-bcf6-85d2cdd6174c",
"job_type_code": "sample string 7",
"job_type": {
"id": "455ecdf8-c1bc-4ab8-b52a-d795e172aaec",
"name": "sample string 2",
"sales_organization_id": "68db5185-97c2-4686-8632-66b5a0e21c5f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-20T11:20:00.8090761+00:00",
"code": "sample string 7"
},
"job_priority_id": "72c232ce-33df-4e94-848b-5b91dd4494de",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b7db62d1-0175-4eea-a6f7-a6040d1a36d3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "01f36c44-882f-449f-bae3-807bf47ffcc4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "90a864d3-07b0-462a-9c43-07bc3a6f11d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42b2193c-bf39-444b-8092-aae707acb13d",
"db_currency_id": "24e8154d-4662-44fb-8e9f-7a4a80e4c9e5",
"db_language_id": "7d8b2d63-a56e-499f-9dc2-4bef9ef3bd7c",
"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-20T11:20:00.8090761+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-20T11:20:00.8090761+00:00"
},
"job_status_id": "aa9fc671-cff9-4bb8-aad2-c15a79d196a8",
"job_status_code": "sample string 11",
"db_address_id": "5b752a6a-782b-45a2-8f50-b9a9fb31a354",
"contact_id": "f4e7e2b7-d2c4-4750-b796-365b762759a1",
"requested_by_company_id": "dd79f8d8-7a6a-47dd-8073-07d8b760a843",
"requested_by_contact_id": "0220b101-79cb-4a05-bca7-fd4c2421daa4",
"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-20T11:20:00.8090761+00:00",
"due_date": "2026-08-20T11:20:00.8090761+00:00",
"date_create": "2026-08-20T11:20:00.8090761+00:00",
"date_update": "2026-08-20T11:20:00.8090761+00:00",
"date_closed": "2026-08-20T11:20:00.8090761+00:00",
"suggested_user_id": "4a9954d8-daeb-48af-975e-01a4e7a588c1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8c6d3ff6-9906-470a-bc5e-4156f6a424b3",
"db_language_id": "ef843aab-7b2f-445d-8f92-35c208de0c18",
"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-20T11:20:00.8090761+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bb8f41a9-e93e-47c8-8153-e7508c17d4d2",
"sales_organization": {
"id": "90a864d3-07b0-462a-9c43-07bc3a6f11d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42b2193c-bf39-444b-8092-aae707acb13d",
"db_currency_id": "24e8154d-4662-44fb-8e9f-7a4a80e4c9e5",
"db_language_id": "7d8b2d63-a56e-499f-9dc2-4bef9ef3bd7c",
"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-20T11:20:00.8090761+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "edd7ffb7-c694-425e-990c-783795c73be0",
"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": "c67543bc-abd9-446b-8c13-b940e6572f70",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-20T11:20:00.8090761+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6580d3c2-a670-4974-8463-38c2c36427a5"
},
"suggested_date_start": "2026-08-20T11:20:00.8090761+00:00",
"skill_id": "1b92e5fb-f6d9-4da8-89d1-a684a60bf742",
"skill_code": "sample string 32",
"skill": {
"id": "61827e26-9f05-4376-8d89-e389aa17df75",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "28f7e85f-b62a-4ec3-81ed-00847b579ab0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "90a864d3-07b0-462a-9c43-07bc3a6f11d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "42b2193c-bf39-444b-8092-aae707acb13d",
"db_currency_id": "24e8154d-4662-44fb-8e9f-7a4a80e4c9e5",
"db_language_id": "7d8b2d63-a56e-499f-9dc2-4bef9ef3bd7c",
"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-20T11:20:00.8090761+00:00"
},
"modified_dateutc": "2026-08-20T11:20:00.8090761+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9d38edbf-20d2-4078-a42f-8d63dd23c5fe",
"date_reported_by_company": "2026-08-20T11:20:00.8090761+00:00",
"id2": 36,
"company_id": "523fcab8-87c9-43ae-8141-9c0e7f94172b",
"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": "f0cd5a7d-1e15-4f75-91bb-dde226dae118",
"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-20T11:20:00.8090761+00:00"
},
"work_instruction_details_id": "4494320f-13ae-48ee-921d-902f5b9149b9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6951c18c-7fa0-4351-adfc-fd2e918170fe",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "00259179-f2e6-4c73-ba5b-817a75e293ef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-20T11:20:00.8090761+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": "56eac3ac-53d8-48f7-85e2-0f2ea7c038c0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-20T11:20:00.8090761+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.