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": "2c718984-b8c1-4af5-a6c5-2e6286b9e193",
"jobs_id": "469374f0-7426-43c5-a06a-c39b4134ed6b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fada9af9-35af-49b0-873c-6ddef2074745",
"_parent_id": "279683c8-7eff-4947-ab44-c0d962255449",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7cc8d7d2-2cab-4eef-a8b1-adca4a161fc7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "553f1918-8302-4ada-b0b1-69681bafb9a6",
"_parent_id": "eccedc98-dbd5-4437-9b33-9d24a1f83147",
"root_parent_id": "7db23b97-8918-49e1-bae3-e1eaa9c13a3e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f743bfae-8189-4520-8ba5-f627116f6d40",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d753faa8-af56-4aba-a3cf-391f7e6ec311",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cac704a0-8966-47aa-8d05-8951c4f02b5a",
"_parent_code": "sample string 6",
"sales_organization_id": "0144cbce-f4ed-4fcc-8d8d-91425bfde37b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "269b56ac-dd42-4233-8a8f-182a3c9033ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4578afa5-14a4-451a-907e-4b9bc25b9276",
"db_currency_id": "f636d5f5-26e3-43a6-9407-a8a8b8c5f9e5",
"db_language_id": "b0df6276-fbe1-41c0-b482-8fc7bfeae1c7",
"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-23T20:48:18.8402049+00:00"
},
"modified_dateutc": "2025-12-23T20:48:18.8402049+00:00"
},
"equipment_model_id": "e5704e44-bac8-45ab-a826-0e9b65d3c988",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fc491fed-f050-4a95-b02a-c32b0391bc4d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5ff4f0ff-20cf-4655-953a-39c601db27ba",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0ddf1901-54c3-4a90-a5fe-92d34f159f45",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "08315ba7-3295-4ff8-b8f5-98ce54edd8e6",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "269b56ac-dd42-4233-8a8f-182a3c9033ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4578afa5-14a4-451a-907e-4b9bc25b9276",
"db_currency_id": "f636d5f5-26e3-43a6-9407-a8a8b8c5f9e5",
"db_language_id": "b0df6276-fbe1-41c0-b482-8fc7bfeae1c7",
"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-23T20:48:18.8402049+00:00"
},
"modified_dateutc": "2025-12-23T20:48:18.8402049+00:00"
},
"equipment_family_id": "cbadf43b-d3f0-4e4b-9aae-6577b83e74ff",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d753faa8-af56-4aba-a3cf-391f7e6ec311",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cac704a0-8966-47aa-8d05-8951c4f02b5a",
"_parent_code": "sample string 6",
"sales_organization_id": "0144cbce-f4ed-4fcc-8d8d-91425bfde37b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "269b56ac-dd42-4233-8a8f-182a3c9033ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4578afa5-14a4-451a-907e-4b9bc25b9276",
"db_currency_id": "f636d5f5-26e3-43a6-9407-a8a8b8c5f9e5",
"db_language_id": "b0df6276-fbe1-41c0-b482-8fc7bfeae1c7",
"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-23T20:48:18.8402049+00:00"
},
"modified_dateutc": "2025-12-23T20:48:18.8402049+00:00"
},
"date_in_production_since": "2025-12-23T20:48:18.8402049+00:00",
"date_out_of_production_since": "2025-12-23T20:48:18.8402049+00:00",
"date_end_support": "2025-12-23T20:48:18.8402049+00:00",
"sales_organization_id": "9cbddff6-0af9-4e9c-a7a0-afb687c57e26",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "269b56ac-dd42-4233-8a8f-182a3c9033ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4578afa5-14a4-451a-907e-4b9bc25b9276",
"db_currency_id": "f636d5f5-26e3-43a6-9407-a8a8b8c5f9e5",
"db_language_id": "b0df6276-fbe1-41c0-b482-8fc7bfeae1c7",
"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-23T20:48:18.8402049+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-23T20:48:18.8402049+00:00"
},
"project_status_id": "23e5dc5d-bc0e-4e96-b706-52302ddf0bea",
"project_status_code": "sample string 10",
"project_status": {
"id": "4744b817-7f93-424a-8b63-599335d8bc24",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e0951ff8-6e5f-4044-888a-433a96e6c48f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "269b56ac-dd42-4233-8a8f-182a3c9033ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4578afa5-14a4-451a-907e-4b9bc25b9276",
"db_currency_id": "f636d5f5-26e3-43a6-9407-a8a8b8c5f9e5",
"db_language_id": "b0df6276-fbe1-41c0-b482-8fc7bfeae1c7",
"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-23T20:48:18.8402049+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T20:48:18.8402049+00:00"
},
"company_id": "0c99ad1f-d27f-40ae-9637-827f59eb4e6a",
"company_code": "sample string 12",
"db_address_id": "6f9b5b36-aaa8-45e3-91cd-266a6d877412",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "edb485b4-6706-493d-ba87-d2ce7f067142",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5c140eb6-ff2b-4ed6-9cf0-20abf2a30f0a",
"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-23T20:48:18.8402049+00:00",
"date_create": "2025-12-23T20:48:18.8402049+00:00",
"date_update": "2025-12-23T20:48:18.8402049+00:00",
"updated_by_user_id": "4fe3cca4-e96b-44b6-bf74-4cec56a4058d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-23T20:48:18.8402049+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-23T20:48:18.8402049+00:00",
"date_last_job": "2025-12-23T20:48:18.8402049+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-23T20:48:18.8402049+00:00",
"modified_dateutc": "2025-12-23T20:48:18.8402049+00:00",
"is_mobile_installation": true
},
"job_type_id": "d6877fd8-2d78-4c7d-b1a9-93a9ca659f6f",
"job_type_code": "sample string 7",
"job_type": {
"id": "5d666098-3736-4da9-83ab-d30e51f14a2f",
"name": "sample string 2",
"sales_organization_id": "e9d57dc2-f05a-4c37-8d8f-d83d2f81cdf3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-23T20:48:18.8402049+00:00",
"code": "sample string 7"
},
"job_priority_id": "7c1e2f26-1658-46a6-9a6a-a5127d00a418",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6ceec4dd-e4bb-449c-9978-fc013073f832",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a16d723e-d42b-4936-890b-25857ea9db65",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "269b56ac-dd42-4233-8a8f-182a3c9033ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4578afa5-14a4-451a-907e-4b9bc25b9276",
"db_currency_id": "f636d5f5-26e3-43a6-9407-a8a8b8c5f9e5",
"db_language_id": "b0df6276-fbe1-41c0-b482-8fc7bfeae1c7",
"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-23T20:48:18.8402049+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-23T20:48:18.8402049+00:00"
},
"job_status_id": "7f6facae-9b4e-4a3b-8ce9-2bfcf6f2bd55",
"job_status_code": "sample string 11",
"db_address_id": "545d6329-b599-4030-8c4b-072ebcdf5e44",
"contact_id": "f9171477-f9dc-4c2f-a8cb-e198be694d24",
"requested_by_company_id": "c3e8be4f-ea75-4074-ad9d-7e301b26238a",
"requested_by_contact_id": "419f7a0a-7727-491f-9983-7d82b1c491d5",
"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-23T20:48:18.8402049+00:00",
"due_date": "2025-12-23T20:48:18.8402049+00:00",
"date_create": "2025-12-23T20:48:18.8402049+00:00",
"date_update": "2025-12-23T20:48:18.8402049+00:00",
"date_closed": "2025-12-23T20:48:18.8402049+00:00",
"suggested_user_id": "f925852d-0dca-43fa-8cc2-21ff8987e348",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5a3c85b0-f194-490f-ba9e-3aa588de24b6",
"db_language_id": "820a4e9a-618c-4895-9a9f-7a62280c8de0",
"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-23T20:48:18.8402049+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "01c30813-fa55-48cf-a7d9-808d4551fc03",
"sales_organization": {
"id": "269b56ac-dd42-4233-8a8f-182a3c9033ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4578afa5-14a4-451a-907e-4b9bc25b9276",
"db_currency_id": "f636d5f5-26e3-43a6-9407-a8a8b8c5f9e5",
"db_language_id": "b0df6276-fbe1-41c0-b482-8fc7bfeae1c7",
"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-23T20:48:18.8402049+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bab8e18b-ec17-4269-b6eb-4f52773f036c",
"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": "b97cdd2c-d56f-4237-a027-29e01b9c5bdb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-23T20:48:18.8402049+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b4efccfc-363a-44ab-899f-cf1b83bccac5"
},
"suggested_date_start": "2025-12-23T20:48:18.8402049+00:00",
"skill_id": "b6a9cc16-bbcc-49de-b077-3bd3f9491b93",
"skill_code": "sample string 32",
"skill": {
"id": "9d7f6c0c-7f19-4c9e-892a-5825b0d394d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "63baaf40-1d8d-4757-a64f-442add3f796c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "269b56ac-dd42-4233-8a8f-182a3c9033ab",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4578afa5-14a4-451a-907e-4b9bc25b9276",
"db_currency_id": "f636d5f5-26e3-43a6-9407-a8a8b8c5f9e5",
"db_language_id": "b0df6276-fbe1-41c0-b482-8fc7bfeae1c7",
"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-23T20:48:18.8402049+00:00"
},
"modified_dateutc": "2025-12-23T20:48:18.8402049+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9067e551-5d89-41dd-914b-240c1fe66b34",
"date_reported_by_company": "2025-12-23T20:48:18.8402049+00:00",
"id2": 36,
"company_id": "533a13d6-4b14-4ed0-b886-7fc586c147c2",
"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": "293369c3-cd1d-423b-863e-57e89e9b7742",
"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-23T20:48:18.8402049+00:00"
},
"work_instruction_details_id": "0b603a8d-8aed-4626-a8ca-37eacb15ca2d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5edddfca-7342-4df7-8d95-609fca3a9ca4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c9bf3c08-03b3-4c3c-9528-1ed12a6dbbef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-23T20:48:18.8402049+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": "f7ea546d-e585-4e90-87cf-2bba6b5c0c52",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-23T20:48:18.8402049+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.