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": "37d2900c-c6df-433a-84ed-e2c0fb9a4b31",
"jobs_id": "f5e8ec72-ce9e-47de-ac83-9641f61acf93",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2a434532-5a8c-490d-9721-c7f8bc565c3d",
"_parent_id": "3f955e8e-2c27-4b18-9012-d454f456d0da",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f2420f7a-884c-42a0-9808-bb98c73f32f8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "780c9704-61f9-4d5a-930d-79f34924977e",
"_parent_id": "aba03457-2cca-4dec-8106-e248855042e3",
"root_parent_id": "16016f59-f72e-43fa-9285-93741e807cb6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8d9e2234-0b7d-480b-81b6-3e8b422971bc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c9acfe5b-fd8d-4cf9-b8f4-e6f58318da61",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "17a4529b-7370-4b75-934f-4f1c03cd99f5",
"_parent_code": "sample string 6",
"sales_organization_id": "c841f230-c709-4560-a4e2-3f00b14f147a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7c9fe967-096f-402c-b682-4fd8c3eeae48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac07868d-ac8c-433e-8c1a-e0df384e6889",
"db_currency_id": "750a0225-e89c-4b6c-a304-3f2be2e6f5a8",
"db_language_id": "f8e22fb2-4dc8-4570-a04a-bfa3e6d57b13",
"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-06-08T14:37:47.9933449+00:00"
},
"modified_dateutc": "2026-06-08T14:37:47.9933449+00:00"
},
"equipment_model_id": "5deda039-4a8d-4af5-aa53-3dcbb63a3285",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "613b4463-9986-4531-9920-5615da5fef25",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1d88c2c4-61bb-49a1-a4a2-790daeb9e60d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a02e1b6d-14d3-44b6-b5e1-58c7625bec42",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "91c8aa58-5c09-431e-bfd6-e073dedc77f4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7c9fe967-096f-402c-b682-4fd8c3eeae48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac07868d-ac8c-433e-8c1a-e0df384e6889",
"db_currency_id": "750a0225-e89c-4b6c-a304-3f2be2e6f5a8",
"db_language_id": "f8e22fb2-4dc8-4570-a04a-bfa3e6d57b13",
"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-06-08T14:37:47.9933449+00:00"
},
"modified_dateutc": "2026-06-08T14:37:47.9933449+00:00"
},
"equipment_family_id": "64dbd904-2cf2-4796-b3a9-d249ab8c2280",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c9acfe5b-fd8d-4cf9-b8f4-e6f58318da61",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "17a4529b-7370-4b75-934f-4f1c03cd99f5",
"_parent_code": "sample string 6",
"sales_organization_id": "c841f230-c709-4560-a4e2-3f00b14f147a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7c9fe967-096f-402c-b682-4fd8c3eeae48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac07868d-ac8c-433e-8c1a-e0df384e6889",
"db_currency_id": "750a0225-e89c-4b6c-a304-3f2be2e6f5a8",
"db_language_id": "f8e22fb2-4dc8-4570-a04a-bfa3e6d57b13",
"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-06-08T14:37:47.9933449+00:00"
},
"modified_dateutc": "2026-06-08T14:37:47.9933449+00:00"
},
"date_in_production_since": "2026-06-08T14:37:47.9933449+00:00",
"date_out_of_production_since": "2026-06-08T14:37:47.9933449+00:00",
"date_end_support": "2026-06-08T14:37:47.9933449+00:00",
"sales_organization_id": "dbd47320-4cc8-4afa-ab42-f86c059a75aa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7c9fe967-096f-402c-b682-4fd8c3eeae48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac07868d-ac8c-433e-8c1a-e0df384e6889",
"db_currency_id": "750a0225-e89c-4b6c-a304-3f2be2e6f5a8",
"db_language_id": "f8e22fb2-4dc8-4570-a04a-bfa3e6d57b13",
"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-06-08T14:37:47.9933449+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-06-08T14:37:47.9933449+00:00"
},
"project_status_id": "0d485854-158e-46f2-9e30-fde4c188554f",
"project_status_code": "sample string 10",
"project_status": {
"id": "e1756686-39b6-4953-a0b9-9d3eeb90240a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c0703c88-b75c-4794-b6fe-725c546c0f28",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7c9fe967-096f-402c-b682-4fd8c3eeae48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac07868d-ac8c-433e-8c1a-e0df384e6889",
"db_currency_id": "750a0225-e89c-4b6c-a304-3f2be2e6f5a8",
"db_language_id": "f8e22fb2-4dc8-4570-a04a-bfa3e6d57b13",
"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-06-08T14:37:47.9933449+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-08T14:37:47.9933449+00:00"
},
"company_id": "4261d359-6f5e-4214-a54e-409b9599dec1",
"company_code": "sample string 12",
"db_address_id": "f6c278eb-800e-4831-a6ce-a61fb20cb619",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "88a72b9c-7d9d-4c39-9391-72038d99643e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "44bdf54a-23cd-4171-9673-7d7c80133349",
"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-06-08T14:37:47.9933449+00:00",
"date_create": "2026-06-08T14:37:47.9933449+00:00",
"date_update": "2026-06-08T14:37:47.9933449+00:00",
"updated_by_user_id": "42a2899a-49fa-422d-89d0-b1244a95955c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-08T14:37:47.9933449+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-06-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-08T14:37:47.9933449+00:00",
"date_last_job": "2026-06-08T14:37:47.9933449+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-08T14:37:47.9933449+00:00",
"modified_dateutc": "2026-06-08T14:37:47.9933449+00:00",
"is_mobile_installation": true
},
"job_type_id": "a2b3ad98-319a-4607-a5e4-48e7794fb993",
"job_type_code": "sample string 7",
"job_type": {
"id": "b6b98939-d7d6-4167-a4ee-49f9cdc7f89d",
"name": "sample string 2",
"sales_organization_id": "8ebdd67a-ae5b-420a-9541-25f098907c25",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-08T14:37:47.9933449+00:00",
"code": "sample string 7"
},
"job_priority_id": "48dba259-a7c3-4c39-aac6-7e87ecfb9ffc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b5b9ce68-d904-41cc-8a10-4579f678376d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "62b1c5cd-07b6-416f-ae39-153a0a98ccd5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7c9fe967-096f-402c-b682-4fd8c3eeae48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac07868d-ac8c-433e-8c1a-e0df384e6889",
"db_currency_id": "750a0225-e89c-4b6c-a304-3f2be2e6f5a8",
"db_language_id": "f8e22fb2-4dc8-4570-a04a-bfa3e6d57b13",
"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-06-08T14:37:47.9933449+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-08T14:37:47.9933449+00:00"
},
"job_status_id": "889e3d86-d819-4957-9cfb-3a96f8c01d0a",
"job_status_code": "sample string 11",
"db_address_id": "b53384da-1b86-4ae1-b9cd-04061e16106a",
"contact_id": "d0b2caa7-5270-456d-b4f1-e46fcfd4ace8",
"requested_by_company_id": "e97cefe4-6153-48ae-891e-4f9f48071fa5",
"requested_by_contact_id": "000c060f-516b-460f-b674-5c2f4b24f467",
"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-06-08T14:37:47.9933449+00:00",
"due_date": "2026-06-08T14:37:47.9933449+00:00",
"date_create": "2026-06-08T14:37:47.9933449+00:00",
"date_update": "2026-06-08T14:37:47.9933449+00:00",
"date_closed": "2026-06-08T14:37:47.9933449+00:00",
"suggested_user_id": "e8079caa-e254-4397-9214-d1c3bfb495e2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "183ee404-dba0-451d-8de6-8d731b0a93d3",
"db_language_id": "40c94ef4-664c-4d98-ac78-d6c95c2dd210",
"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-06-08T14:37:47.9933449+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f9c825ee-535d-4a51-933c-5dd9493fbccf",
"sales_organization": {
"id": "7c9fe967-096f-402c-b682-4fd8c3eeae48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac07868d-ac8c-433e-8c1a-e0df384e6889",
"db_currency_id": "750a0225-e89c-4b6c-a304-3f2be2e6f5a8",
"db_language_id": "f8e22fb2-4dc8-4570-a04a-bfa3e6d57b13",
"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-06-08T14:37:47.9933449+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "846a5b76-0e83-4319-9ef7-2b9fb2f8c4b1",
"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": "84b823e9-cf15-43f4-85b0-c46d5ad6dd93",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-08T14:37:47.9933449+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "489cfd33-25ec-4183-aef7-08f50e0cef05"
},
"suggested_date_start": "2026-06-08T14:37:47.9933449+00:00",
"skill_id": "4166b5d7-6dda-43e0-ad37-ed0ac883b0c0",
"skill_code": "sample string 32",
"skill": {
"id": "c30e53de-66a5-4472-88a1-4ffd1d71f9ad",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "20ffd724-a0e0-4b9f-bacf-007b358ccf85",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7c9fe967-096f-402c-b682-4fd8c3eeae48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac07868d-ac8c-433e-8c1a-e0df384e6889",
"db_currency_id": "750a0225-e89c-4b6c-a304-3f2be2e6f5a8",
"db_language_id": "f8e22fb2-4dc8-4570-a04a-bfa3e6d57b13",
"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-06-08T14:37:47.9933449+00:00"
},
"modified_dateutc": "2026-06-08T14:37:47.9933449+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2f71b50c-40da-46aa-a1a5-4c984d40866d",
"date_reported_by_company": "2026-06-08T14:37:47.9933449+00:00",
"id2": 36,
"company_id": "3154d312-cd9c-45d6-bd6e-26cd5cf99b19",
"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": "fe2d25c1-1374-43b0-a7a4-5bb7b1c16657",
"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-06-08T14:37:47.9933449+00:00"
},
"work_instruction_details_id": "d4764573-6bbf-4518-bb39-e2a9e5568d22",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "810b4e4c-e0d9-4645-bd37-6b5fa2f787be",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "245436a3-d65a-4a4f-af0c-5d5d7759d987",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-08T14:37:47.9933449+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": "70042370-3b79-4e3f-a841-cc334f5d6306",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-08T14:37:47.9933449+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.