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": "71e7cdc0-7296-42e1-8c3f-d65793c8c6a1",
"jobs_id": "f9f29829-abd2-4488-b7a7-d418cbb2d3b1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d3a3e613-645e-4b66-9435-6875570bea34",
"_parent_id": "764f4d70-1737-4aed-98c5-6a93e3373a7c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "91e84ce7-9471-4e21-a982-c64583185bec",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2c509291-8fde-4068-836f-f9f735350503",
"_parent_id": "a77e3509-00c9-4221-8610-e1c6e236f641",
"root_parent_id": "de683af4-18db-44db-9e82-23f800447b03",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "12534afb-1525-430a-bce3-409827b4d5b5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "87cd474c-19b4-4ddc-9d04-af796aa9874b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "546298ae-32bd-48a7-b914-83afec58ece5",
"_parent_code": "sample string 6",
"sales_organization_id": "09b794ff-5d20-45a9-9ce4-c7f8e8f0ff9c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ebdc500-3b52-4b32-89b1-5617d0d69490",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e41c8ae-5925-43c6-92d4-ad24fbbd1e10",
"db_currency_id": "fc54eec0-18be-49ca-97b9-90faa12cf289",
"db_language_id": "c9e21b1b-9aa0-44fb-b2b3-c590d1a34c49",
"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-01-01T14:11:51.3203252+00:00"
},
"modified_dateutc": "2026-01-01T14:11:51.3203252+00:00"
},
"equipment_model_id": "6d254d8e-56e4-4fa3-a95e-b18b0c4e2f1d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b4f68b2d-054f-4f15-824b-816b33254f36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "535be25e-11bb-49cb-8d0d-ab22ae6b6312",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bec21a59-e2cb-4a99-b915-71db86b11389",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3d52bb4c-d731-4ade-aae2-80792582b9bb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9ebdc500-3b52-4b32-89b1-5617d0d69490",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e41c8ae-5925-43c6-92d4-ad24fbbd1e10",
"db_currency_id": "fc54eec0-18be-49ca-97b9-90faa12cf289",
"db_language_id": "c9e21b1b-9aa0-44fb-b2b3-c590d1a34c49",
"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-01-01T14:11:51.3203252+00:00"
},
"modified_dateutc": "2026-01-01T14:11:51.3203252+00:00"
},
"equipment_family_id": "78f4e790-0dd0-473c-97c2-b19a60e620ee",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "87cd474c-19b4-4ddc-9d04-af796aa9874b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "546298ae-32bd-48a7-b914-83afec58ece5",
"_parent_code": "sample string 6",
"sales_organization_id": "09b794ff-5d20-45a9-9ce4-c7f8e8f0ff9c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9ebdc500-3b52-4b32-89b1-5617d0d69490",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e41c8ae-5925-43c6-92d4-ad24fbbd1e10",
"db_currency_id": "fc54eec0-18be-49ca-97b9-90faa12cf289",
"db_language_id": "c9e21b1b-9aa0-44fb-b2b3-c590d1a34c49",
"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-01-01T14:11:51.3203252+00:00"
},
"modified_dateutc": "2026-01-01T14:11:51.3203252+00:00"
},
"date_in_production_since": "2026-01-01T14:11:51.3203252+00:00",
"date_out_of_production_since": "2026-01-01T14:11:51.3203252+00:00",
"date_end_support": "2026-01-01T14:11:51.3203252+00:00",
"sales_organization_id": "548badb8-20b2-492c-91b2-698f11a5353c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9ebdc500-3b52-4b32-89b1-5617d0d69490",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e41c8ae-5925-43c6-92d4-ad24fbbd1e10",
"db_currency_id": "fc54eec0-18be-49ca-97b9-90faa12cf289",
"db_language_id": "c9e21b1b-9aa0-44fb-b2b3-c590d1a34c49",
"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-01-01T14:11:51.3203252+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-01-01T14:11:51.3203252+00:00"
},
"project_status_id": "0aac884c-03f1-4495-b567-5509f41a5dd0",
"project_status_code": "sample string 10",
"project_status": {
"id": "d6286131-7d43-4dce-ac2d-1c960d7f624a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "27c9c237-6835-4365-8247-8decde705a4f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ebdc500-3b52-4b32-89b1-5617d0d69490",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e41c8ae-5925-43c6-92d4-ad24fbbd1e10",
"db_currency_id": "fc54eec0-18be-49ca-97b9-90faa12cf289",
"db_language_id": "c9e21b1b-9aa0-44fb-b2b3-c590d1a34c49",
"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-01-01T14:11:51.3203252+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-01T14:11:51.3203252+00:00"
},
"company_id": "cb1d4a7f-c5d8-471d-aed4-1a14e7bad21c",
"company_code": "sample string 12",
"db_address_id": "3dfb6b07-8ba3-4972-b30b-9d446334adcc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a4f5b006-de3f-48ba-b0c8-6c7321e6a342",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e5f31627-69a0-45ba-b465-db0c9e911724",
"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-01-01T14:11:51.3203252+00:00",
"date_create": "2026-01-01T14:11:51.3203252+00:00",
"date_update": "2026-01-01T14:11:51.3203252+00:00",
"updated_by_user_id": "6c46c2bf-fac3-4294-91af-b16bf361be2b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-01T14:11:51.3203252+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-01-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-01T14:11:51.3203252+00:00",
"date_last_job": "2026-01-01T14:11:51.3203252+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-01T14:11:51.3203252+00:00",
"modified_dateutc": "2026-01-01T14:11:51.3203252+00:00",
"is_mobile_installation": true
},
"job_type_id": "445d158f-932d-453b-9aae-d714f221ddd7",
"job_type_code": "sample string 7",
"job_type": {
"id": "6695b370-c53d-46c4-ae13-b0ec303a1b12",
"name": "sample string 2",
"sales_organization_id": "d32b5a43-6439-4812-aede-a5a7c3f6ab87",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-01T14:11:51.3203252+00:00",
"code": "sample string 7"
},
"job_priority_id": "a2259fe3-bc43-4cea-aed2-092d2001cb9a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "772a0e74-c6fb-4738-a0bb-6461ee34d268",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fe85907b-3b7a-4d49-9440-e85f7fc5755c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ebdc500-3b52-4b32-89b1-5617d0d69490",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e41c8ae-5925-43c6-92d4-ad24fbbd1e10",
"db_currency_id": "fc54eec0-18be-49ca-97b9-90faa12cf289",
"db_language_id": "c9e21b1b-9aa0-44fb-b2b3-c590d1a34c49",
"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-01-01T14:11:51.3203252+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-01T14:11:51.3203252+00:00"
},
"job_status_id": "1bdde48d-330e-4f3c-9a98-101efea7cf24",
"job_status_code": "sample string 11",
"db_address_id": "a405fdfb-ae27-4cdb-82da-86b4d0d1bff1",
"contact_id": "d388f0cd-0874-44f4-9b3a-0b1adbadb80b",
"requested_by_company_id": "28337eff-0f2c-427e-9f23-1eb0c1982adf",
"requested_by_contact_id": "e5f3273a-a912-46e6-8760-f4b221d6cd14",
"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-01-01T14:11:51.3203252+00:00",
"due_date": "2026-01-01T14:11:51.3203252+00:00",
"date_create": "2026-01-01T14:11:51.3203252+00:00",
"date_update": "2026-01-01T14:11:51.3203252+00:00",
"date_closed": "2026-01-01T14:11:51.3203252+00:00",
"suggested_user_id": "fc04f772-7d7c-40fd-9208-8ffdbba44208",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ea074433-498b-4437-94bf-d4f7d16942ad",
"db_language_id": "ada46aa8-46b5-4e0a-8c52-0e0fc655b377",
"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-01-01T14:11:51.3203252+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "357790f0-70bf-497e-b4b4-17105e0cb1e1",
"sales_organization": {
"id": "9ebdc500-3b52-4b32-89b1-5617d0d69490",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e41c8ae-5925-43c6-92d4-ad24fbbd1e10",
"db_currency_id": "fc54eec0-18be-49ca-97b9-90faa12cf289",
"db_language_id": "c9e21b1b-9aa0-44fb-b2b3-c590d1a34c49",
"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-01-01T14:11:51.3203252+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0a62782c-1ed0-4ddb-b786-b15a25612f10",
"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": "517441c2-2c01-4570-9220-96a6f0feaf1b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-01T14:11:51.3203252+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "72b7fe48-80ad-45cf-a4f0-0abc9fa2eb6e"
},
"suggested_date_start": "2026-01-01T14:11:51.3203252+00:00",
"skill_id": "da6ad13a-59b8-4870-a6f8-a00bfa7c8213",
"skill_code": "sample string 32",
"skill": {
"id": "ec14e4d2-161d-47d7-bfdf-a63a3f615ffc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "03bca423-57d8-474d-9c44-9ab85491cfb9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9ebdc500-3b52-4b32-89b1-5617d0d69490",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2e41c8ae-5925-43c6-92d4-ad24fbbd1e10",
"db_currency_id": "fc54eec0-18be-49ca-97b9-90faa12cf289",
"db_language_id": "c9e21b1b-9aa0-44fb-b2b3-c590d1a34c49",
"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-01-01T14:11:51.3203252+00:00"
},
"modified_dateutc": "2026-01-01T14:11:51.3203252+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "becf4f66-e18e-4939-b4f2-ac318ad4a908",
"date_reported_by_company": "2026-01-01T14:11:51.3203252+00:00",
"id2": 36,
"company_id": "74cd2bb1-9104-4653-871a-d7425d73befe",
"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": "62c324d5-08cb-4953-82d6-422cfb3a0703",
"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-01-01T14:11:51.3203252+00:00"
},
"work_instruction_details_id": "1d7e5d4d-4f54-4d86-a9b1-cb245a000013",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f8b15837-0490-4843-b6ce-e0922a76ea77",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "892baf2b-90cc-4fd1-b78c-97f110f425f6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-01T14:11:51.3203252+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": "b0deab64-2371-45c7-8f6b-9cf66771bc82",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-01T14:11:51.3203252+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.