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": "bfa7d1e6-10fe-438a-9b46-07548fb25113",
"jobs_id": "9c8edea6-5cae-4240-85eb-04506849d612",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d8d85fb1-6920-4813-9615-f87acb263796",
"_parent_id": "be933d6a-98ea-4c89-8538-23046778a506",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "68285688-4ee6-4251-88e8-d411991aa459",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4907b107-abab-4fbe-b05e-b986c26df201",
"_parent_id": "c39f93bb-9bd8-409a-8772-30b266ea28bf",
"root_parent_id": "6b7dfd75-4f7a-489d-ab86-a3a67d834a9c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2af40492-180a-4524-95ee-92685a4eb236",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2d8789e7-2a1b-454a-ae09-214fe5077eeb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2e6f4805-bfd2-4fa0-813c-06cc22e65f14",
"_parent_code": "sample string 6",
"sales_organization_id": "ee32c46b-0ca5-49de-871c-25ad6447fa54",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "27391893-f6f9-466d-bacf-5846879babb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dd75f44b-643e-4f27-a577-2b1fca85857a",
"db_currency_id": "76bee38c-6091-49ae-84ec-d5f927f84e64",
"db_language_id": "eb7566c4-6f82-4ff9-9064-e8b6f978d7d3",
"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-08-05T13:46:25.8903693+00:00"
},
"modified_dateutc": "2025-08-05T13:46:25.8903693+00:00"
},
"equipment_model_id": "29453fa0-bc42-4415-ac70-8b6cd237ca0d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4fd1b771-1c20-49ab-a1ec-6543c5cb78f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "494b4334-0686-4f7e-a3af-514af030325d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "630425c0-8239-4d6a-8fca-518a59a71cd2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fb52f85a-d1a2-4955-87b8-e9b66ad05310",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "27391893-f6f9-466d-bacf-5846879babb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dd75f44b-643e-4f27-a577-2b1fca85857a",
"db_currency_id": "76bee38c-6091-49ae-84ec-d5f927f84e64",
"db_language_id": "eb7566c4-6f82-4ff9-9064-e8b6f978d7d3",
"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-08-05T13:46:25.8903693+00:00"
},
"modified_dateutc": "2025-08-05T13:46:25.8903693+00:00"
},
"equipment_family_id": "a601977c-c411-4fac-b68b-d55476cd917e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2d8789e7-2a1b-454a-ae09-214fe5077eeb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2e6f4805-bfd2-4fa0-813c-06cc22e65f14",
"_parent_code": "sample string 6",
"sales_organization_id": "ee32c46b-0ca5-49de-871c-25ad6447fa54",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "27391893-f6f9-466d-bacf-5846879babb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dd75f44b-643e-4f27-a577-2b1fca85857a",
"db_currency_id": "76bee38c-6091-49ae-84ec-d5f927f84e64",
"db_language_id": "eb7566c4-6f82-4ff9-9064-e8b6f978d7d3",
"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-08-05T13:46:25.8903693+00:00"
},
"modified_dateutc": "2025-08-05T13:46:25.8903693+00:00"
},
"date_in_production_since": "2025-08-05T13:46:25.8903693+00:00",
"date_out_of_production_since": "2025-08-05T13:46:25.8903693+00:00",
"date_end_support": "2025-08-05T13:46:25.8903693+00:00",
"sales_organization_id": "d78ee343-1665-4c9e-85b7-7d848611b80f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "27391893-f6f9-466d-bacf-5846879babb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dd75f44b-643e-4f27-a577-2b1fca85857a",
"db_currency_id": "76bee38c-6091-49ae-84ec-d5f927f84e64",
"db_language_id": "eb7566c4-6f82-4ff9-9064-e8b6f978d7d3",
"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-08-05T13:46:25.8903693+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-08-05T13:46:25.8903693+00:00"
},
"project_status_id": "f85090e2-60e1-4004-a001-98af2b89280b",
"project_status_code": "sample string 10",
"project_status": {
"id": "fa378818-2f48-467a-9066-06354f869696",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5bd0e8af-c938-4af8-acf1-0343845cba89",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "27391893-f6f9-466d-bacf-5846879babb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dd75f44b-643e-4f27-a577-2b1fca85857a",
"db_currency_id": "76bee38c-6091-49ae-84ec-d5f927f84e64",
"db_language_id": "eb7566c4-6f82-4ff9-9064-e8b6f978d7d3",
"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-08-05T13:46:25.8903693+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-05T13:46:25.8903693+00:00"
},
"company_id": "fecd0220-0c25-4ed8-942d-b2df8f047725",
"company_code": "sample string 12",
"db_address_id": "8cd48a66-a6c7-4e54-8141-bca37b44952b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5247c9e3-6178-4d21-bb9b-0440ed4476c0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fd02b348-10e2-462f-9d95-6e2fcafe5daa",
"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-08-05T13:46:25.8903693+00:00",
"date_create": "2025-08-05T13:46:25.8903693+00:00",
"date_update": "2025-08-05T13:46:25.8903693+00:00",
"updated_by_user_id": "a873ce55-22b4-4af2-8279-d2ed02823778",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-08-05T13:46:25.8903693+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-08-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-08-05T13:46:25.8903693+00:00",
"date_last_job": "2025-08-05T13:46:25.8903693+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-08-05T13:46:25.8903693+00:00",
"modified_dateutc": "2025-08-05T13:46:25.8903693+00:00",
"is_mobile_installation": true
},
"job_type_id": "868577e9-110e-47ff-a2ef-56c37848dcda",
"job_type_code": "sample string 7",
"job_type": {
"id": "01509d6b-9e90-45de-88c9-34311aada62e",
"name": "sample string 2",
"sales_organization_id": "4bd433dd-1f30-4024-ad11-2d39d2b88232",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-08-05T13:46:25.8903693+00:00",
"code": "sample string 7"
},
"job_priority_id": "03996462-b634-4c4d-bc98-ae000f7903ae",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "747699bd-5c05-4c0c-ba1a-d2c49f0aab16",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "01c81816-d02e-4919-9a88-ebf0af5e1814",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "27391893-f6f9-466d-bacf-5846879babb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dd75f44b-643e-4f27-a577-2b1fca85857a",
"db_currency_id": "76bee38c-6091-49ae-84ec-d5f927f84e64",
"db_language_id": "eb7566c4-6f82-4ff9-9064-e8b6f978d7d3",
"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-08-05T13:46:25.8903693+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-05T13:46:25.8903693+00:00"
},
"job_status_id": "0ef12ee7-c4d3-48f5-bda2-2ff1f083ee4c",
"job_status_code": "sample string 11",
"db_address_id": "c106fb66-af1c-4c4a-88f5-9144afd10055",
"contact_id": "7c65a7be-363a-4ceb-8d83-d2206b79921b",
"requested_by_company_id": "31f8719f-98a5-44d8-92cc-dada6b0e57a8",
"requested_by_contact_id": "435a8129-e32a-493e-98cc-06c3852195ec",
"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-08-05T13:46:25.8903693+00:00",
"due_date": "2025-08-05T13:46:25.8903693+00:00",
"date_create": "2025-08-05T13:46:25.8903693+00:00",
"date_update": "2025-08-05T13:46:25.8903693+00:00",
"date_closed": "2025-08-05T13:46:25.8903693+00:00",
"suggested_user_id": "b37484a1-8766-4334-a6d6-d3b39c4e4907",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "70d8a5e1-5b55-4455-b2c7-c750606ebbab",
"db_language_id": "78f1c022-6830-497e-8ab6-895f66071617",
"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-08-05T13:46:25.8903693+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4823e70e-4b86-40e4-8ffe-d9cfe01b477f",
"sales_organization": {
"id": "27391893-f6f9-466d-bacf-5846879babb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dd75f44b-643e-4f27-a577-2b1fca85857a",
"db_currency_id": "76bee38c-6091-49ae-84ec-d5f927f84e64",
"db_language_id": "eb7566c4-6f82-4ff9-9064-e8b6f978d7d3",
"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-08-05T13:46:25.8903693+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "29eeae2f-28ee-45b2-8a2f-c76e157cc59d",
"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": "6b635c97-ecef-48ee-aef6-df5599844b1a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-08-05T13:46:25.8903693+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5ccd5266-ed4d-47fb-ad37-b18b20e02d63"
},
"suggested_date_start": "2025-08-05T13:46:25.8903693+00:00",
"skill_id": "0164e281-a186-437a-9696-1f5a30f8ae4e",
"skill_code": "sample string 32",
"skill": {
"id": "5329cd09-c8bb-4974-95b2-7565f60c4fab",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "76701570-1162-4e25-9e32-158b5d7a9269",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "27391893-f6f9-466d-bacf-5846879babb2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dd75f44b-643e-4f27-a577-2b1fca85857a",
"db_currency_id": "76bee38c-6091-49ae-84ec-d5f927f84e64",
"db_language_id": "eb7566c4-6f82-4ff9-9064-e8b6f978d7d3",
"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-08-05T13:46:25.8903693+00:00"
},
"modified_dateutc": "2025-08-05T13:46:25.8903693+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d8096c87-569e-4175-b78a-5d95d9c8ba5d",
"date_reported_by_company": "2025-08-05T13:46:25.8903693+00:00",
"id2": 36,
"company_id": "979032db-8d58-4de5-8f4c-77522ac8aec9",
"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": "81201120-5ef8-434c-b4f6-d7a90448dfe2",
"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-08-05T13:46:25.8903693+00:00"
},
"work_instruction_details_id": "6e3afd0b-0d5e-4fd3-8787-a484cc08300f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a247f60c-db45-4e49-8450-ff5cd0c8de20",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b4e2b729-e0e1-4836-a75b-977fc79624c7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-08-05T13:46:25.905992+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": "f2619f4a-40aa-4751-9d86-7f6f353b525a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-08-05T13:46:25.905992+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.