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": "f5f5a6e4-b272-460b-ac21-71bbad7788dc",
"jobs_id": "70f49cd9-469a-4a00-b2ff-63e5178e720f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0945c42c-0226-42ad-98d7-df7ea8e70667",
"_parent_id": "6b287746-4e1f-42a3-8a50-5385e239a1b7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f7618417-9090-4750-ab22-9bcd72102e99",
"project_reference_back_office": "sample string 5",
"project": {
"id": "00314821-330d-4ff2-ad98-dfc23568263b",
"_parent_id": "621fe081-a1ed-44a1-9d47-cca3008c108b",
"root_parent_id": "a0571faa-5edb-425e-b050-535ae99406b5",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0c752a1a-783d-48cb-973d-f1489f4c1aa2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b1922611-93e8-4a03-974f-da4643d7ad92",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7259eef6-2b2a-4c99-bb01-e7af2725a9cd",
"_parent_code": "sample string 6",
"sales_organization_id": "a7e068f9-f512-464b-ba39-d21f25d15cfc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b7ceccd8-f5fc-4d23-b89d-da2f734d2e2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5589382-2af5-4d1b-b3c0-c2c848b1d96b",
"db_currency_id": "dc5cf632-f379-4c4e-be81-3f5a6a24b596",
"db_language_id": "9e216682-ff44-41df-aabb-ed6d5df9b99a",
"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-23T05:04:49.8278718+00:00"
},
"modified_dateutc": "2026-01-23T05:04:49.8278718+00:00"
},
"equipment_model_id": "503fe14c-a280-4ba1-96ab-9787d0784dc9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3ecb10b8-b07e-4965-8669-ef5285c36d79",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "98d89616-2464-4b62-800d-7e4981f9f204",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ec495f86-c96e-48ca-8c8a-5c6828e91356",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bfa524f9-9aba-4ae7-80a7-64ea6f097107",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b7ceccd8-f5fc-4d23-b89d-da2f734d2e2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5589382-2af5-4d1b-b3c0-c2c848b1d96b",
"db_currency_id": "dc5cf632-f379-4c4e-be81-3f5a6a24b596",
"db_language_id": "9e216682-ff44-41df-aabb-ed6d5df9b99a",
"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-23T05:04:49.8278718+00:00"
},
"modified_dateutc": "2026-01-23T05:04:49.8278718+00:00"
},
"equipment_family_id": "247066dd-1f4b-4a9b-9fb6-f5e173e58f1f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b1922611-93e8-4a03-974f-da4643d7ad92",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7259eef6-2b2a-4c99-bb01-e7af2725a9cd",
"_parent_code": "sample string 6",
"sales_organization_id": "a7e068f9-f512-464b-ba39-d21f25d15cfc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b7ceccd8-f5fc-4d23-b89d-da2f734d2e2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5589382-2af5-4d1b-b3c0-c2c848b1d96b",
"db_currency_id": "dc5cf632-f379-4c4e-be81-3f5a6a24b596",
"db_language_id": "9e216682-ff44-41df-aabb-ed6d5df9b99a",
"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-23T05:04:49.8278718+00:00"
},
"modified_dateutc": "2026-01-23T05:04:49.8278718+00:00"
},
"date_in_production_since": "2026-01-23T05:04:49.8278718+00:00",
"date_out_of_production_since": "2026-01-23T05:04:49.8278718+00:00",
"date_end_support": "2026-01-23T05:04:49.8278718+00:00",
"sales_organization_id": "68410805-ea20-4c21-83ce-bb29324bb648",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b7ceccd8-f5fc-4d23-b89d-da2f734d2e2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5589382-2af5-4d1b-b3c0-c2c848b1d96b",
"db_currency_id": "dc5cf632-f379-4c4e-be81-3f5a6a24b596",
"db_language_id": "9e216682-ff44-41df-aabb-ed6d5df9b99a",
"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-23T05:04:49.8278718+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-23T05:04:49.8278718+00:00"
},
"project_status_id": "376f2033-c3e8-4241-b7d3-97ab85d2625a",
"project_status_code": "sample string 10",
"project_status": {
"id": "16305c1a-5c4c-46ab-b3d0-c839470f5731",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "329c5e25-9155-4e49-bb93-b773a7ae3275",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b7ceccd8-f5fc-4d23-b89d-da2f734d2e2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5589382-2af5-4d1b-b3c0-c2c848b1d96b",
"db_currency_id": "dc5cf632-f379-4c4e-be81-3f5a6a24b596",
"db_language_id": "9e216682-ff44-41df-aabb-ed6d5df9b99a",
"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-23T05:04:49.8278718+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-23T05:04:49.8278718+00:00"
},
"company_id": "ea012b4d-ea33-4750-bf95-1fa12edee9a1",
"company_code": "sample string 12",
"db_address_id": "6c92845b-443b-494c-97e4-b3ae57fce522",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "18c16986-e19c-47ae-a1ee-8a238974bd87",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "75e75b33-bb66-4d77-98a3-f1d7a47ce6b8",
"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-23T05:04:49.8278718+00:00",
"date_create": "2026-01-23T05:04:49.8278718+00:00",
"date_update": "2026-01-23T05:04:49.8278718+00:00",
"updated_by_user_id": "b2118cc0-b497-4fc4-a655-f03f3b97910c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-23T05:04:49.8278718+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-23T05:04:49.8278718+00:00",
"date_last_job": "2026-01-23T05:04:49.8278718+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-23T05:04:49.8278718+00:00",
"modified_dateutc": "2026-01-23T05:04:49.8278718+00:00",
"is_mobile_installation": true
},
"job_type_id": "ae455683-4ed4-4c16-bc41-25bbd93cf801",
"job_type_code": "sample string 7",
"job_type": {
"id": "3fcb224c-f4f5-4a0b-af53-943b6981243a",
"name": "sample string 2",
"sales_organization_id": "2f16a7f2-f636-4174-9e74-182c1c67f2b9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-23T05:04:49.8278718+00:00",
"code": "sample string 7"
},
"job_priority_id": "a34cd2e9-6019-4349-b3b8-89bcb828c309",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ce3fc31b-e05b-495f-b428-58decbd63503",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "82b4edad-93ce-4bdd-b4b0-5a7d67257ebc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b7ceccd8-f5fc-4d23-b89d-da2f734d2e2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5589382-2af5-4d1b-b3c0-c2c848b1d96b",
"db_currency_id": "dc5cf632-f379-4c4e-be81-3f5a6a24b596",
"db_language_id": "9e216682-ff44-41df-aabb-ed6d5df9b99a",
"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-23T05:04:49.8278718+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-23T05:04:49.8278718+00:00"
},
"job_status_id": "eca39203-5d23-4660-9939-0b966301f30b",
"job_status_code": "sample string 11",
"db_address_id": "4b37a8eb-fee8-4d51-91e2-4de0d017e477",
"contact_id": "0b115f23-ecb3-45a8-a971-260cf6de58b4",
"requested_by_company_id": "60d6cdd9-02a3-488e-b241-9861463973f0",
"requested_by_contact_id": "f1082060-e51d-4bb8-b692-0a1ef672eb1b",
"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-23T05:04:49.8278718+00:00",
"due_date": "2026-01-23T05:04:49.8278718+00:00",
"date_create": "2026-01-23T05:04:49.8278718+00:00",
"date_update": "2026-01-23T05:04:49.8278718+00:00",
"date_closed": "2026-01-23T05:04:49.8278718+00:00",
"suggested_user_id": "7a114c3e-d6f8-41a9-90fc-63e8abe24140",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2509ec72-49a9-41e6-b88a-78adb43263b6",
"db_language_id": "e6951c05-1f62-4b9c-941b-9e896ff9cab7",
"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-23T05:04:49.8278718+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bd2442d9-9fc6-4186-9798-5c670e4be41a",
"sales_organization": {
"id": "b7ceccd8-f5fc-4d23-b89d-da2f734d2e2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5589382-2af5-4d1b-b3c0-c2c848b1d96b",
"db_currency_id": "dc5cf632-f379-4c4e-be81-3f5a6a24b596",
"db_language_id": "9e216682-ff44-41df-aabb-ed6d5df9b99a",
"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-23T05:04:49.8278718+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3a496479-069d-41b7-a2c1-b2fe0904e1fd",
"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": "a0fee354-e30d-4622-92eb-f6db056b16e6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-23T05:04:49.8278718+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b0385c0c-29f6-4316-a02b-7eed8a825686"
},
"suggested_date_start": "2026-01-23T05:04:49.8278718+00:00",
"skill_id": "67667798-c516-49b0-844c-0c8a47922de7",
"skill_code": "sample string 32",
"skill": {
"id": "9ef28873-6462-4b15-83f3-3b30332dde27",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1e06e85d-ae53-4cbe-b51c-fc311ce9b0a0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b7ceccd8-f5fc-4d23-b89d-da2f734d2e2c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f5589382-2af5-4d1b-b3c0-c2c848b1d96b",
"db_currency_id": "dc5cf632-f379-4c4e-be81-3f5a6a24b596",
"db_language_id": "9e216682-ff44-41df-aabb-ed6d5df9b99a",
"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-23T05:04:49.8278718+00:00"
},
"modified_dateutc": "2026-01-23T05:04:49.8278718+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "56810504-6a7d-4320-92fc-326a5e324889",
"date_reported_by_company": "2026-01-23T05:04:49.8278718+00:00",
"id2": 36,
"company_id": "51bd437b-7d53-4059-90eb-b752667da71d",
"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": "fad96a35-f858-4053-8bf5-6a313698968c",
"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-23T05:04:49.8278718+00:00"
},
"work_instruction_details_id": "81e77e63-18f2-4ca8-bea1-e842304d2572",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2b1b39eb-2a4d-432a-bd2f-5bd464e14ba1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5e7a241d-a1d9-4198-b8bc-88e1e48814b3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-23T05:04:49.8278718+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": "fd554336-452b-4ece-a7dd-83b13fbaa205",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-23T05:04:49.8278718+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.