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": "bbcb6abb-0a8c-4237-ba56-3b938deecb62",
"jobs_id": "fa56a07f-79f7-4698-81b1-a4b4942c8b87",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2da9050b-8c40-43cb-93ba-cd0d7362820c",
"_parent_id": "01932f18-a062-4e77-9cde-265a4c0f602f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9089bea1-3aeb-4021-a27a-79e9104f8b40",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ddff35a1-b8eb-42cd-bb22-2f695883e383",
"_parent_id": "b68b0f63-5f0d-46fb-866c-07db3c45c212",
"root_parent_id": "2f54e286-74af-4538-907b-8f4ef85dabe5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5667d859-68c0-4163-b6b1-50bef264441e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "216ec1f9-09b9-4da5-a5a1-a2ef4ffb536e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "896dde8a-0793-4bd8-932e-a893b28ce3b9",
"_parent_code": "sample string 6",
"sales_organization_id": "cd364cb1-2524-4fd6-892c-ab8be82fdbde",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "463f38d3-4215-4d9c-9ec3-6f55e20703ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0a6af-170e-4938-ab70-c23a405cce30",
"db_currency_id": "1fc5e32d-20b6-4ed2-96bb-deb8d0a3193a",
"db_language_id": "604a0486-03dd-412c-b1e8-04e0fa78dae6",
"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-09-16T12:22:40.1566492+00:00"
},
"modified_dateutc": "2025-09-16T12:22:40.1566492+00:00"
},
"equipment_model_id": "45cc4938-b943-463f-9c4c-95691f01ac72",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c98f0465-a2c5-4b84-9aea-5f77f36260ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "88b137c8-fdc9-460d-a228-43408356b674",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "034170e0-c114-4b50-9369-3271c6f25238",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "899141d0-53c8-44ee-b661-f943e1dd9120",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "463f38d3-4215-4d9c-9ec3-6f55e20703ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0a6af-170e-4938-ab70-c23a405cce30",
"db_currency_id": "1fc5e32d-20b6-4ed2-96bb-deb8d0a3193a",
"db_language_id": "604a0486-03dd-412c-b1e8-04e0fa78dae6",
"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-09-16T12:22:40.1566492+00:00"
},
"modified_dateutc": "2025-09-16T12:22:40.1566492+00:00"
},
"equipment_family_id": "5efc428f-0095-44ea-a630-9932dfee4209",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "216ec1f9-09b9-4da5-a5a1-a2ef4ffb536e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "896dde8a-0793-4bd8-932e-a893b28ce3b9",
"_parent_code": "sample string 6",
"sales_organization_id": "cd364cb1-2524-4fd6-892c-ab8be82fdbde",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "463f38d3-4215-4d9c-9ec3-6f55e20703ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0a6af-170e-4938-ab70-c23a405cce30",
"db_currency_id": "1fc5e32d-20b6-4ed2-96bb-deb8d0a3193a",
"db_language_id": "604a0486-03dd-412c-b1e8-04e0fa78dae6",
"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-09-16T12:22:40.1566492+00:00"
},
"modified_dateutc": "2025-09-16T12:22:40.1566492+00:00"
},
"date_in_production_since": "2025-09-16T12:22:40.1566492+00:00",
"date_out_of_production_since": "2025-09-16T12:22:40.1566492+00:00",
"date_end_support": "2025-09-16T12:22:40.1566492+00:00",
"sales_organization_id": "a7b18ed5-f739-4783-b97d-e3283413c36c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "463f38d3-4215-4d9c-9ec3-6f55e20703ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0a6af-170e-4938-ab70-c23a405cce30",
"db_currency_id": "1fc5e32d-20b6-4ed2-96bb-deb8d0a3193a",
"db_language_id": "604a0486-03dd-412c-b1e8-04e0fa78dae6",
"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-09-16T12:22:40.1566492+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-09-16T12:22:40.1566492+00:00"
},
"project_status_id": "b04d720a-ce00-462f-839a-1c28afa0490d",
"project_status_code": "sample string 10",
"project_status": {
"id": "e7fae81f-fca1-48b0-bbc2-3339332adff9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "447f0f0a-1a1c-4672-a96b-f9c5b21da012",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "463f38d3-4215-4d9c-9ec3-6f55e20703ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0a6af-170e-4938-ab70-c23a405cce30",
"db_currency_id": "1fc5e32d-20b6-4ed2-96bb-deb8d0a3193a",
"db_language_id": "604a0486-03dd-412c-b1e8-04e0fa78dae6",
"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-09-16T12:22:40.1566492+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-16T12:22:40.1566492+00:00"
},
"company_id": "bd016078-26a6-4bc8-bbb5-940d9ce6a98a",
"company_code": "sample string 12",
"db_address_id": "1327fb63-05f1-4c50-972c-4348695a85b6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b0fd0583-8439-46da-a604-e1a99d33c0fa",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e179200c-323b-403c-9c3a-5a6e85ad4bef",
"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-09-16T12:22:40.1566492+00:00",
"date_create": "2025-09-16T12:22:40.1566492+00:00",
"date_update": "2025-09-16T12:22:40.1566492+00:00",
"updated_by_user_id": "55357aba-826d-4bce-8253-a53576479d2c",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-16T12:22:40.1566492+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-09-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-16T12:22:40.1566492+00:00",
"date_last_job": "2025-09-16T12:22:40.1566492+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-16T12:22:40.1566492+00:00",
"modified_dateutc": "2025-09-16T12:22:40.1566492+00:00",
"is_mobile_installation": true
},
"job_type_id": "5fd79b88-b333-4e42-8877-688232cbbef3",
"job_type_code": "sample string 7",
"job_type": {
"id": "33248357-16fc-446d-a5f7-de42d5c404e4",
"name": "sample string 2",
"sales_organization_id": "8227a241-96b4-4179-9cc1-cc875e118d65",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-16T12:22:40.1566492+00:00",
"code": "sample string 7"
},
"job_priority_id": "fe29528c-4bb0-4690-b370-d4925d4edc3b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3dd53f7e-aadf-4a6f-84f6-46ed54682fb3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8324e156-fd1b-4600-9264-e1fe165ab98f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "463f38d3-4215-4d9c-9ec3-6f55e20703ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0a6af-170e-4938-ab70-c23a405cce30",
"db_currency_id": "1fc5e32d-20b6-4ed2-96bb-deb8d0a3193a",
"db_language_id": "604a0486-03dd-412c-b1e8-04e0fa78dae6",
"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-09-16T12:22:40.1566492+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-16T12:22:40.1566492+00:00"
},
"job_status_id": "301ac4eb-8e9b-4796-9df1-8a9b1357c180",
"job_status_code": "sample string 11",
"db_address_id": "02b124fd-4bfe-466f-b52d-2cff3edbab80",
"contact_id": "746dcdfb-c36f-455d-bb07-30f37b357080",
"requested_by_company_id": "18d584e4-02c6-4397-807f-c5652fb85233",
"requested_by_contact_id": "51c0cd3f-4e25-43f8-9e6a-6b2ee0f0efad",
"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-09-16T12:22:40.1566492+00:00",
"due_date": "2025-09-16T12:22:40.1566492+00:00",
"date_create": "2025-09-16T12:22:40.1566492+00:00",
"date_update": "2025-09-16T12:22:40.1566492+00:00",
"date_closed": "2025-09-16T12:22:40.1566492+00:00",
"suggested_user_id": "195b2625-a245-4fae-bef6-dda607dfdfd7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "307eab3b-f1df-4fb4-b131-8a9c986238f4",
"db_language_id": "7df7427f-b5a9-4d07-a52d-54866e2b8664",
"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-09-16T12:22:40.1566492+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "71a86a72-b584-4f7e-b3c6-7eb5b1892c38",
"sales_organization": {
"id": "463f38d3-4215-4d9c-9ec3-6f55e20703ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0a6af-170e-4938-ab70-c23a405cce30",
"db_currency_id": "1fc5e32d-20b6-4ed2-96bb-deb8d0a3193a",
"db_language_id": "604a0486-03dd-412c-b1e8-04e0fa78dae6",
"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-09-16T12:22:40.1566492+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "17e1c09f-1305-476a-a2ea-9683c4d5e178",
"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": "91fdbe2f-31fa-469b-9495-56cb42c62789",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-16T12:22:40.1566492+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "bbc7bac8-ab77-4189-8a23-019351988676"
},
"suggested_date_start": "2025-09-16T12:22:40.1566492+00:00",
"skill_id": "55a1b1ed-5824-4940-b4e3-58c11da19c74",
"skill_code": "sample string 32",
"skill": {
"id": "248d7392-18eb-435e-8aae-acf2e66503e4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d2c669a0-b2a8-4b51-9471-3e97d384e687",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "463f38d3-4215-4d9c-9ec3-6f55e20703ea",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ab0a6af-170e-4938-ab70-c23a405cce30",
"db_currency_id": "1fc5e32d-20b6-4ed2-96bb-deb8d0a3193a",
"db_language_id": "604a0486-03dd-412c-b1e8-04e0fa78dae6",
"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-09-16T12:22:40.1566492+00:00"
},
"modified_dateutc": "2025-09-16T12:22:40.1566492+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "de6dd84b-d618-445a-9be9-d4cea295d253",
"date_reported_by_company": "2025-09-16T12:22:40.1566492+00:00",
"id2": 36,
"company_id": "e2487980-1b70-4207-8553-20ebff37ae51",
"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": "ade76592-b615-4398-a29c-65de28a4a0e5",
"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-09-16T12:22:40.1566492+00:00"
},
"work_instruction_details_id": "ac60dc13-129c-4004-a2b9-6b7f0610eec1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f8f751ba-9d5d-4ead-bf55-00c3066c3d18",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3f69b339-b690-4467-824c-fc551a671bed",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-16T12:22:40.1566492+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": "d6a71347-6874-46dd-b117-626b95351941",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-16T12:22:40.1566492+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.