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": "fbe4ccde-eadc-4d43-ba2d-d7e35ada9a68",
"jobs_id": "c61a902d-b10b-4526-95ab-3ba91e0910fd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "062fc63c-e2ad-46ec-88f1-cbd506934649",
"_parent_id": "c997e14f-561f-4a96-a5bc-8589d0bb77c9",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4ae7d1c5-0f4f-40b4-96af-ed681405172e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e0fb194e-822d-4447-ab36-b8cd12f5d877",
"_parent_id": "24cd71b8-47e7-4b98-895d-aa1ae1a3f48e",
"root_parent_id": "bc3c0454-72ba-4c9d-86e9-edf1a03ee935",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8d4de150-7de2-4ce3-8a7f-bb942ce1a4df",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5942d5a0-a173-4a38-a008-8cf021adc1dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "266b36de-5d57-4fc5-b15f-512a033a8120",
"_parent_code": "sample string 6",
"sales_organization_id": "32a86b51-f7fa-4d17-bc23-e151cba9fe6a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9c4f4df0-c6a9-48c1-a38d-fcb8081c1a46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86703b08-d4b8-4133-a147-18f8c1fdae11",
"db_currency_id": "e0f4814b-6a84-4695-a495-d45a0699121d",
"db_language_id": "30f7ea51-67ee-4abd-bc02-54303321d9bd",
"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-09-04T14:10:36.7575461+00:00"
},
"modified_dateutc": "2026-09-04T14:10:36.7575461+00:00"
},
"equipment_model_id": "6873eae2-f057-4817-aea7-1143df2e281e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e8fbaf7f-8985-4d32-ba05-ada1bb05d182",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "97d640b8-0bc1-4fff-a32d-c69aba74e8e4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4bf63733-02ad-46aa-8207-90be607a92a9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ee54ef45-2c4f-47e6-8f46-730a48ea3f6e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9c4f4df0-c6a9-48c1-a38d-fcb8081c1a46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86703b08-d4b8-4133-a147-18f8c1fdae11",
"db_currency_id": "e0f4814b-6a84-4695-a495-d45a0699121d",
"db_language_id": "30f7ea51-67ee-4abd-bc02-54303321d9bd",
"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-09-04T14:10:36.7575461+00:00"
},
"modified_dateutc": "2026-09-04T14:10:36.7575461+00:00"
},
"equipment_family_id": "e20398b8-880a-4863-b3f8-ab8475372f53",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5942d5a0-a173-4a38-a008-8cf021adc1dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "266b36de-5d57-4fc5-b15f-512a033a8120",
"_parent_code": "sample string 6",
"sales_organization_id": "32a86b51-f7fa-4d17-bc23-e151cba9fe6a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9c4f4df0-c6a9-48c1-a38d-fcb8081c1a46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86703b08-d4b8-4133-a147-18f8c1fdae11",
"db_currency_id": "e0f4814b-6a84-4695-a495-d45a0699121d",
"db_language_id": "30f7ea51-67ee-4abd-bc02-54303321d9bd",
"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-09-04T14:10:36.7575461+00:00"
},
"modified_dateutc": "2026-09-04T14:10:36.7575461+00:00"
},
"date_in_production_since": "2026-09-04T14:10:36.7575461+00:00",
"date_out_of_production_since": "2026-09-04T14:10:36.7575461+00:00",
"date_end_support": "2026-09-04T14:10:36.7575461+00:00",
"sales_organization_id": "3190e898-4be8-47c9-93b7-88b680caecb2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9c4f4df0-c6a9-48c1-a38d-fcb8081c1a46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86703b08-d4b8-4133-a147-18f8c1fdae11",
"db_currency_id": "e0f4814b-6a84-4695-a495-d45a0699121d",
"db_language_id": "30f7ea51-67ee-4abd-bc02-54303321d9bd",
"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-09-04T14:10:36.7575461+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-09-04T14:10:36.7575461+00:00"
},
"project_status_id": "0514c326-916f-493c-9b69-4d9c8c09fb65",
"project_status_code": "sample string 10",
"project_status": {
"id": "2f24506b-f91f-4760-9960-eab789993429",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1eac1d63-4998-4c9b-8f22-b1a74350acf6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9c4f4df0-c6a9-48c1-a38d-fcb8081c1a46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86703b08-d4b8-4133-a147-18f8c1fdae11",
"db_currency_id": "e0f4814b-6a84-4695-a495-d45a0699121d",
"db_language_id": "30f7ea51-67ee-4abd-bc02-54303321d9bd",
"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-09-04T14:10:36.7575461+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T14:10:36.7575461+00:00"
},
"company_id": "d49c66b3-5fd8-4c4b-8cf8-327e804db5e9",
"company_code": "sample string 12",
"db_address_id": "264cb94c-532d-4022-820a-b41b56a5f2ae",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "36ff939a-edab-4d73-9b9a-0c63444765cb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7e362956-13d1-4bdf-a2c5-0e8af31194b4",
"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-09-04T14:10:36.7575461+00:00",
"date_create": "2026-09-04T14:10:36.7575461+00:00",
"date_update": "2026-09-04T14:10:36.7575461+00:00",
"updated_by_user_id": "bf5c2d04-8ad3-4358-b295-24fcf84f007e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-04T14:10:36.7575461+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-09-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-04T14:10:36.7575461+00:00",
"date_last_job": "2026-09-04T14:10:36.7575461+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-04T14:10:36.7575461+00:00",
"modified_dateutc": "2026-09-04T14:10:36.7575461+00:00",
"is_mobile_installation": true
},
"job_type_id": "6a6465a4-43eb-4a04-ba93-8094bee22fe3",
"job_type_code": "sample string 7",
"job_type": {
"id": "cfbaf78e-8f8f-428e-ac9a-dffb69fa3077",
"name": "sample string 2",
"sales_organization_id": "51b27656-db7b-4e2c-a663-ed18efa2b67e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-04T14:10:36.7575461+00:00",
"code": "sample string 7"
},
"job_priority_id": "78d4c96b-1371-47f7-b74f-41c334e57767",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "10f5f41d-c2ca-4fee-a0fc-373f75fb6739",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2add5e4c-c3fc-4e8f-bbe1-291c59f1eb9e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9c4f4df0-c6a9-48c1-a38d-fcb8081c1a46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86703b08-d4b8-4133-a147-18f8c1fdae11",
"db_currency_id": "e0f4814b-6a84-4695-a495-d45a0699121d",
"db_language_id": "30f7ea51-67ee-4abd-bc02-54303321d9bd",
"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-09-04T14:10:36.7575461+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-04T14:10:36.7575461+00:00"
},
"job_status_id": "30ae1516-b169-4e60-ac5b-54194591e539",
"job_status_code": "sample string 11",
"db_address_id": "51f87415-1af1-4682-9272-e58229574deb",
"contact_id": "f4c83567-5f36-42e8-b664-c9639a276169",
"requested_by_company_id": "afdc58c9-7790-4cd3-8222-140e6cab914a",
"requested_by_contact_id": "f589f3a1-f4c5-4354-8270-045c0e91b4cb",
"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-09-04T14:10:36.7575461+00:00",
"due_date": "2026-09-04T14:10:36.7575461+00:00",
"date_create": "2026-09-04T14:10:36.7575461+00:00",
"date_update": "2026-09-04T14:10:36.7575461+00:00",
"date_closed": "2026-09-04T14:10:36.7575461+00:00",
"suggested_user_id": "3a2f3436-cb92-4c1b-8e99-cb057e3c416e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "430e6d10-b8af-4e63-94b3-38fdb98bd4a7",
"db_language_id": "1f2161ff-41ef-4e81-a918-40105cb6b745",
"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-09-04T14:10:36.7575461+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "82dc94c6-a641-4cea-aad1-72110488512f",
"sales_organization": {
"id": "9c4f4df0-c6a9-48c1-a38d-fcb8081c1a46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86703b08-d4b8-4133-a147-18f8c1fdae11",
"db_currency_id": "e0f4814b-6a84-4695-a495-d45a0699121d",
"db_language_id": "30f7ea51-67ee-4abd-bc02-54303321d9bd",
"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-09-04T14:10:36.7575461+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "95049125-db48-40df-b90d-71c1515df63a",
"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": "5d4ac1b9-4598-4115-ad7b-a0542b7a3b16",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-04T14:10:36.7575461+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "64b3ad44-53a8-4e53-99e3-fac33f5127c6"
},
"suggested_date_start": "2026-09-04T14:10:36.7575461+00:00",
"skill_id": "c6430434-6917-47fe-8b3e-f50f476e95fa",
"skill_code": "sample string 32",
"skill": {
"id": "d814c14a-6f26-4602-b308-95b33f97cbd3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fc840c00-35f3-43ca-b4ac-322ab65f6e21",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9c4f4df0-c6a9-48c1-a38d-fcb8081c1a46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86703b08-d4b8-4133-a147-18f8c1fdae11",
"db_currency_id": "e0f4814b-6a84-4695-a495-d45a0699121d",
"db_language_id": "30f7ea51-67ee-4abd-bc02-54303321d9bd",
"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-09-04T14:10:36.7575461+00:00"
},
"modified_dateutc": "2026-09-04T14:10:36.7575461+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d5131b6c-7533-4c1e-a5ce-9af379dcd3ec",
"date_reported_by_company": "2026-09-04T14:10:36.7575461+00:00",
"id2": 36,
"company_id": "84b2b32b-aeb8-4756-b027-8aa754441602",
"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": "98c586cf-b63a-45b6-bd89-dd2f2dfbf00c",
"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-09-04T14:10:36.7575461+00:00"
},
"work_instruction_details_id": "85a10464-0379-4ee6-b553-b484e93993ea",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "725c5ac3-e67b-4dbf-b34d-fb3920b9810d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7edafc5f-a763-470f-a97d-b371bf484273",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-04T14:10:36.7575461+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": "18938eec-12c2-42dc-8ed8-54d686ba187f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-04T14:10:36.7575461+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.