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": "c2876085-fe4e-4075-a8e6-edc5dc38dff6",
"jobs_id": "da9ecc96-48e6-4464-9af6-c59abf64bde1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c9037e13-30ec-4d7a-b502-72c525e596d9",
"_parent_id": "6348a956-ec0d-43b3-85b5-3bd43e09ec0d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b4e1e993-952b-4096-9cdf-36c1fc008335",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c4d5788d-0d4b-462b-975e-07db1558b948",
"_parent_id": "99c89cd3-5dd9-4402-81a7-27103e6331ef",
"root_parent_id": "8aa5e1ae-4e02-4b6a-b53a-ce028f62916e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "219de109-9713-4414-9acd-69951ccaee45",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e68225aa-f7bb-471c-b5b9-2fd1386248b0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d27f3cf5-4f8a-483f-9e0c-6fddcef3b1be",
"_parent_code": "sample string 6",
"sales_organization_id": "adc5827e-3957-451b-981b-daf6b6396a62",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fb55203b-a3e1-401b-ab55-5cf26e19c1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe6661d1-3584-4dfd-b8b0-ff30f6ad58c2",
"db_currency_id": "08569596-9a1d-4e5b-b941-b26d8f1514d4",
"db_language_id": "4a46fe21-6884-4f40-97c4-b3bea97a13c8",
"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-19T08:23:36.4370255+00:00"
},
"modified_dateutc": "2025-12-19T08:23:36.4370255+00:00"
},
"equipment_model_id": "685e0799-ed37-4ec7-8242-74984bd0d6c6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1a9d1a5d-e7ec-402a-9e17-ac46f084ec1d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "de953c9a-7525-40df-ac25-a4319f966f15",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dce38768-61af-4581-842a-d6ba5d12f84d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "494d546f-6663-4b69-b62c-f9856f73cbb9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fb55203b-a3e1-401b-ab55-5cf26e19c1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe6661d1-3584-4dfd-b8b0-ff30f6ad58c2",
"db_currency_id": "08569596-9a1d-4e5b-b941-b26d8f1514d4",
"db_language_id": "4a46fe21-6884-4f40-97c4-b3bea97a13c8",
"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-19T08:23:36.4370255+00:00"
},
"modified_dateutc": "2025-12-19T08:23:36.4370255+00:00"
},
"equipment_family_id": "1dc7b575-3c63-4b29-9676-d4c573a2b373",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e68225aa-f7bb-471c-b5b9-2fd1386248b0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d27f3cf5-4f8a-483f-9e0c-6fddcef3b1be",
"_parent_code": "sample string 6",
"sales_organization_id": "adc5827e-3957-451b-981b-daf6b6396a62",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fb55203b-a3e1-401b-ab55-5cf26e19c1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe6661d1-3584-4dfd-b8b0-ff30f6ad58c2",
"db_currency_id": "08569596-9a1d-4e5b-b941-b26d8f1514d4",
"db_language_id": "4a46fe21-6884-4f40-97c4-b3bea97a13c8",
"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-19T08:23:36.4370255+00:00"
},
"modified_dateutc": "2025-12-19T08:23:36.4370255+00:00"
},
"date_in_production_since": "2025-12-19T08:23:36.4370255+00:00",
"date_out_of_production_since": "2025-12-19T08:23:36.4370255+00:00",
"date_end_support": "2025-12-19T08:23:36.4370255+00:00",
"sales_organization_id": "2773b10e-c98e-4316-90b4-707c22097cd8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fb55203b-a3e1-401b-ab55-5cf26e19c1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe6661d1-3584-4dfd-b8b0-ff30f6ad58c2",
"db_currency_id": "08569596-9a1d-4e5b-b941-b26d8f1514d4",
"db_language_id": "4a46fe21-6884-4f40-97c4-b3bea97a13c8",
"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-19T08:23:36.4370255+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-19T08:23:36.4370255+00:00"
},
"project_status_id": "ba9d4845-5a01-4dbc-b3a5-e5b7ce93dd3e",
"project_status_code": "sample string 10",
"project_status": {
"id": "ddac6326-209b-4ffb-965f-3e80d1ac9aaf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "80169f72-9dcc-4012-8629-da5a56fe0fe8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb55203b-a3e1-401b-ab55-5cf26e19c1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe6661d1-3584-4dfd-b8b0-ff30f6ad58c2",
"db_currency_id": "08569596-9a1d-4e5b-b941-b26d8f1514d4",
"db_language_id": "4a46fe21-6884-4f40-97c4-b3bea97a13c8",
"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-19T08:23:36.4370255+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-19T08:23:36.4370255+00:00"
},
"company_id": "0da8b6a7-e2dc-4166-ba31-5faf2ed88292",
"company_code": "sample string 12",
"db_address_id": "9dbaecd8-531f-464d-8bc9-8568dcaeb931",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fb0c95f7-6501-4c61-91a9-5b1bc9cd8cbe",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2c66e0f3-5847-4afa-a019-f140d030c3dc",
"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-19T08:23:36.4370255+00:00",
"date_create": "2025-12-19T08:23:36.4370255+00:00",
"date_update": "2025-12-19T08:23:36.4370255+00:00",
"updated_by_user_id": "8f152593-1577-432f-a58c-81d8741742a3",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-19T08:23:36.4370255+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-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-19T08:23:36.4370255+00:00",
"date_last_job": "2025-12-19T08:23:36.4370255+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-19T08:23:36.4370255+00:00",
"modified_dateutc": "2025-12-19T08:23:36.4370255+00:00",
"is_mobile_installation": true
},
"job_type_id": "785ade78-20c3-43ea-bb5f-325baa3eb1da",
"job_type_code": "sample string 7",
"job_type": {
"id": "0eb48275-a35b-4a22-8a78-5a6b42a31da8",
"name": "sample string 2",
"sales_organization_id": "62cba31b-a537-4ff5-8ee4-4dda04fb1b8a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-19T08:23:36.4370255+00:00",
"code": "sample string 7"
},
"job_priority_id": "7630a815-e659-48b2-b25c-0fb9d9d9e673",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bb4e2d68-89ae-49da-9eda-d6e014238737",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "42b14005-71b2-4848-92f7-2c85829ad249",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb55203b-a3e1-401b-ab55-5cf26e19c1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe6661d1-3584-4dfd-b8b0-ff30f6ad58c2",
"db_currency_id": "08569596-9a1d-4e5b-b941-b26d8f1514d4",
"db_language_id": "4a46fe21-6884-4f40-97c4-b3bea97a13c8",
"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-19T08:23:36.4370255+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-19T08:23:36.4370255+00:00"
},
"job_status_id": "7bf329d8-8279-4a5a-88bc-790318f6fcb8",
"job_status_code": "sample string 11",
"db_address_id": "888000db-77f6-4182-86bb-5051c3e403a2",
"contact_id": "e1d215d6-1255-4ced-85f8-e752fff325be",
"requested_by_company_id": "7171ac95-fc15-49fb-8241-c3df26668f42",
"requested_by_contact_id": "b40eeca3-3b64-4143-9135-e5fdead33d22",
"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-19T08:23:36.4370255+00:00",
"due_date": "2025-12-19T08:23:36.4370255+00:00",
"date_create": "2025-12-19T08:23:36.4370255+00:00",
"date_update": "2025-12-19T08:23:36.4370255+00:00",
"date_closed": "2025-12-19T08:23:36.4370255+00:00",
"suggested_user_id": "95300370-e4bc-4639-9f11-9fef5c7cefcd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "df5873a9-7c54-404b-9bbd-fc1af7235d8e",
"db_language_id": "f1b47f5e-ab34-47a8-a796-99533beba723",
"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-19T08:23:36.4370255+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8ab89d62-e7f7-43eb-b6a0-ac74e32a1511",
"sales_organization": {
"id": "fb55203b-a3e1-401b-ab55-5cf26e19c1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe6661d1-3584-4dfd-b8b0-ff30f6ad58c2",
"db_currency_id": "08569596-9a1d-4e5b-b941-b26d8f1514d4",
"db_language_id": "4a46fe21-6884-4f40-97c4-b3bea97a13c8",
"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-19T08:23:36.4370255+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "37915df8-5bfa-408c-acc9-d300723613b9",
"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": "ad51b5bf-fd8f-43f8-9ecf-f6b42b7969c3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-19T08:23:36.4526507+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9cb6bbcd-21da-4f91-98b8-0e03eaf0ff2c"
},
"suggested_date_start": "2025-12-19T08:23:36.4526507+00:00",
"skill_id": "c4291ec2-2e43-4878-b96c-d0df813dcb04",
"skill_code": "sample string 32",
"skill": {
"id": "ab43d4c6-4ae3-4f72-82e1-2a35d0d85d62",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1890cf63-30c2-4002-9819-5bcca07df71b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fb55203b-a3e1-401b-ab55-5cf26e19c1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe6661d1-3584-4dfd-b8b0-ff30f6ad58c2",
"db_currency_id": "08569596-9a1d-4e5b-b941-b26d8f1514d4",
"db_language_id": "4a46fe21-6884-4f40-97c4-b3bea97a13c8",
"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-19T08:23:36.4370255+00:00"
},
"modified_dateutc": "2025-12-19T08:23:36.4526507+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5bfc8a05-85d7-483c-83e4-c86b0a9b5324",
"date_reported_by_company": "2025-12-19T08:23:36.4526507+00:00",
"id2": 36,
"company_id": "21be78e6-c0cf-417e-86dc-ca7f3aed9321",
"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": "d97142e4-81e3-4299-8a64-9edfdee519f2",
"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-19T08:23:36.4526507+00:00"
},
"work_instruction_details_id": "6c114e47-0fc0-4651-94df-96430edd8d5b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "01fa6f5e-d9c5-4d70-84c8-8422c9515e1a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "65d7a0f6-977b-4357-be37-6b42ab7af923",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-19T08:23:36.4526507+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": "cfea7c27-477b-45da-beab-2b95bb0b45be",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-19T08:23:36.4526507+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.