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": "883c2683-a6ad-433d-97de-fe6ad90502a4",
"jobs_id": "575c298b-38d3-4a78-a3be-878151d0b984",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2f1fc9a8-71fb-4fb3-ad1b-fa9de219820c",
"_parent_id": "de4bd2c7-f487-4306-97e8-58bab80831d2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bcb5d418-6c66-4dab-ba68-c53f609f8183",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8308cb10-4501-4c20-b5ce-a27106cadb73",
"_parent_id": "4933bb6e-676b-4a2b-9ac8-42b0bdbc64d3",
"root_parent_id": "f2437bbe-0ae9-4466-847b-200665faf5d5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b588e4b6-f4f3-475f-bb07-921e46667b8d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7952e076-5bca-4209-9620-9aa8db0d6e9d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5c80c726-a9a6-4805-a289-aa39e295dc68",
"_parent_code": "sample string 6",
"sales_organization_id": "d24e8c20-46d3-4e86-b9b3-4e73638f1d4a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6cfa6ceb-27f6-40ee-b1ae-b51a40b6902c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7fa08750-d6ce-4073-afd4-c8673908393b",
"db_currency_id": "7fad0f2d-4b45-42bb-a28d-ebd3ad7e58d2",
"db_language_id": "21029fbd-d11e-40f2-ad07-558f8a625979",
"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-08-14T18:45:02.5670644+00:00"
},
"modified_dateutc": "2026-08-14T18:45:02.5670644+00:00"
},
"equipment_model_id": "c05d6a03-7f06-4672-8e05-c892c4a0820b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "527e0ad1-5524-4715-b206-9d656fbd60fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f35a990d-a900-4d28-a61d-b236c7b9d5a6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5504d404-00d3-4ffc-8c9e-b21513b5a90a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0dcb38bc-547c-48b4-9084-6f12be957924",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "6cfa6ceb-27f6-40ee-b1ae-b51a40b6902c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7fa08750-d6ce-4073-afd4-c8673908393b",
"db_currency_id": "7fad0f2d-4b45-42bb-a28d-ebd3ad7e58d2",
"db_language_id": "21029fbd-d11e-40f2-ad07-558f8a625979",
"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-08-14T18:45:02.5670644+00:00"
},
"modified_dateutc": "2026-08-14T18:45:02.5670644+00:00"
},
"equipment_family_id": "e7321d75-fc4f-449e-9512-9e803844240a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7952e076-5bca-4209-9620-9aa8db0d6e9d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5c80c726-a9a6-4805-a289-aa39e295dc68",
"_parent_code": "sample string 6",
"sales_organization_id": "d24e8c20-46d3-4e86-b9b3-4e73638f1d4a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "6cfa6ceb-27f6-40ee-b1ae-b51a40b6902c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7fa08750-d6ce-4073-afd4-c8673908393b",
"db_currency_id": "7fad0f2d-4b45-42bb-a28d-ebd3ad7e58d2",
"db_language_id": "21029fbd-d11e-40f2-ad07-558f8a625979",
"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-08-14T18:45:02.5670644+00:00"
},
"modified_dateutc": "2026-08-14T18:45:02.5670644+00:00"
},
"date_in_production_since": "2026-08-14T18:45:02.5670644+00:00",
"date_out_of_production_since": "2026-08-14T18:45:02.5670644+00:00",
"date_end_support": "2026-08-14T18:45:02.5670644+00:00",
"sales_organization_id": "b0281aa8-6b6d-4ee9-b205-a2e95b9f2678",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "6cfa6ceb-27f6-40ee-b1ae-b51a40b6902c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7fa08750-d6ce-4073-afd4-c8673908393b",
"db_currency_id": "7fad0f2d-4b45-42bb-a28d-ebd3ad7e58d2",
"db_language_id": "21029fbd-d11e-40f2-ad07-558f8a625979",
"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-08-14T18:45:02.5670644+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-08-14T18:45:02.5670644+00:00"
},
"project_status_id": "4ad4dded-09d6-4c9c-b281-15d0f73d7420",
"project_status_code": "sample string 10",
"project_status": {
"id": "1421afda-df72-45ea-ba4e-8af446e41b6d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "52b21202-a440-455b-922c-8a1e9a168d09",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6cfa6ceb-27f6-40ee-b1ae-b51a40b6902c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7fa08750-d6ce-4073-afd4-c8673908393b",
"db_currency_id": "7fad0f2d-4b45-42bb-a28d-ebd3ad7e58d2",
"db_language_id": "21029fbd-d11e-40f2-ad07-558f8a625979",
"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-08-14T18:45:02.5670644+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T18:45:02.5670644+00:00"
},
"company_id": "541842cc-7029-4fe9-af28-347088ffff79",
"company_code": "sample string 12",
"db_address_id": "7cda5ef7-1fca-48b9-a616-8297b351e3c2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1f8f56a4-5580-4bda-b9f0-8536f6d932a1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e216fd06-7631-4cea-995f-fa4f9dc0c8e2",
"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-08-14T18:45:02.5670644+00:00",
"date_create": "2026-08-14T18:45:02.5670644+00:00",
"date_update": "2026-08-14T18:45:02.5670644+00:00",
"updated_by_user_id": "6375f532-5954-412d-97bc-aa232d8d1434",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-14T18:45:02.5670644+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-08-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-14T18:45:02.5670644+00:00",
"date_last_job": "2026-08-14T18:45:02.5670644+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-14T18:45:02.5670644+00:00",
"modified_dateutc": "2026-08-14T18:45:02.5670644+00:00",
"is_mobile_installation": true
},
"job_type_id": "3db930e3-4e04-4901-a83f-12f765b20a75",
"job_type_code": "sample string 7",
"job_type": {
"id": "f9325672-e9b7-491a-be31-1192c45fe8c4",
"name": "sample string 2",
"sales_organization_id": "b27700a2-8adf-476c-b064-9022e728a720",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-14T18:45:02.5670644+00:00",
"code": "sample string 7"
},
"job_priority_id": "6dcee841-ec93-4259-ac08-33048cd243bc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2a9da77f-80f8-4a47-b6da-093d54688841",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "10a46377-3da0-4637-a263-0d380bebcfd1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6cfa6ceb-27f6-40ee-b1ae-b51a40b6902c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7fa08750-d6ce-4073-afd4-c8673908393b",
"db_currency_id": "7fad0f2d-4b45-42bb-a28d-ebd3ad7e58d2",
"db_language_id": "21029fbd-d11e-40f2-ad07-558f8a625979",
"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-08-14T18:45:02.5670644+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T18:45:02.5670644+00:00"
},
"job_status_id": "3f6badc6-934d-469d-8cf0-bcb69ebd5ad8",
"job_status_code": "sample string 11",
"db_address_id": "2414f040-e35d-4028-a458-00710ca170fb",
"contact_id": "c1b585f5-26fb-4be2-a53c-b27191bead1a",
"requested_by_company_id": "bb84a6d0-83e3-4c87-8ef3-68ce741119f7",
"requested_by_contact_id": "01b23a0a-f8d7-423d-b38c-442e4c981cb0",
"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-08-14T18:45:02.5670644+00:00",
"due_date": "2026-08-14T18:45:02.5670644+00:00",
"date_create": "2026-08-14T18:45:02.5670644+00:00",
"date_update": "2026-08-14T18:45:02.5670644+00:00",
"date_closed": "2026-08-14T18:45:02.5670644+00:00",
"suggested_user_id": "087e0e43-dce3-436a-94ea-a665fbaf2e48",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1a7d9893-cf1f-4cea-870d-d013fcaa135e",
"db_language_id": "4cf392b3-6025-407a-be0f-e1f90b325273",
"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-08-14T18:45:02.5670644+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b3f61036-6bdd-44ad-9389-2e6f3303072a",
"sales_organization": {
"id": "6cfa6ceb-27f6-40ee-b1ae-b51a40b6902c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7fa08750-d6ce-4073-afd4-c8673908393b",
"db_currency_id": "7fad0f2d-4b45-42bb-a28d-ebd3ad7e58d2",
"db_language_id": "21029fbd-d11e-40f2-ad07-558f8a625979",
"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-08-14T18:45:02.5670644+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2da121fa-d5a3-46c1-8ff9-d5f4efc2615f",
"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": "364849d4-77d2-4e72-a7ec-ec708f1ee9e3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-14T18:45:02.5670644+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6beb71dc-4a42-43ee-a207-d231d7db3538"
},
"suggested_date_start": "2026-08-14T18:45:02.5670644+00:00",
"skill_id": "a9ddf0ce-c75f-4aea-93ad-b6c6f02513fc",
"skill_code": "sample string 32",
"skill": {
"id": "4754becc-4d14-4c0c-a724-057656cc8795",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f15610a1-8228-4d06-8f6b-d9f187a1ae62",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "6cfa6ceb-27f6-40ee-b1ae-b51a40b6902c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7fa08750-d6ce-4073-afd4-c8673908393b",
"db_currency_id": "7fad0f2d-4b45-42bb-a28d-ebd3ad7e58d2",
"db_language_id": "21029fbd-d11e-40f2-ad07-558f8a625979",
"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-08-14T18:45:02.5670644+00:00"
},
"modified_dateutc": "2026-08-14T18:45:02.5670644+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a0f388cd-1eef-41da-8e67-51981fb461b2",
"date_reported_by_company": "2026-08-14T18:45:02.5670644+00:00",
"id2": 36,
"company_id": "84260133-9541-4f84-bb59-2082a3c6565d",
"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": "bc8f7e19-ba3a-40c4-94b9-52818e6b9120",
"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-08-14T18:45:02.5670644+00:00"
},
"work_instruction_details_id": "fdab96a1-3b92-4eaf-98b5-da024c3b0576",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "89d0a218-8d75-44f4-a1bc-8c75e289332d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7ac9608f-9a02-4818-8bae-691ec33e416f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-14T18:45:02.5670644+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": "6fc297c0-63e1-49e8-8920-f6800be03372",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-14T18:45:02.5670644+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.