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": "d00549ef-35ad-4d59-adf6-897f28abbcf4",
"jobs_id": "13c13425-d4cb-4fe5-8f0f-8c21796fca5e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7cb7b043-17cf-4f27-9665-0c042e24a0f7",
"_parent_id": "5076db3c-9b01-41dc-8299-c57595ee9f53",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c5108214-a5c4-4966-b3c8-455cab5850fa",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2e5f634c-b9f3-476f-a117-8d3af2b37f36",
"_parent_id": "1eb80156-4812-4e21-8aa6-8a8a0fb5540c",
"root_parent_id": "fc58ba7e-54eb-4ee3-9f12-71efdc7026cd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "12747bff-5962-465a-abfc-d766b43112e5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c5a9f4c9-d983-4941-bb07-b97e0d565178",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dc40fcb2-ec0a-495e-a7bf-8c8df570a67c",
"_parent_code": "sample string 6",
"sales_organization_id": "0c08fc0d-055b-4014-ad14-909a43a80291",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0f374085-0278-44ee-840e-d329260f3ddc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4240000-b65a-4b9e-abf1-c6558fc61706",
"db_currency_id": "7b832707-1395-4d9c-a8dc-0395c282c5df",
"db_language_id": "dd84a62a-b726-40d8-93ba-3b8137bda140",
"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-07-15T14:11:02.8642242+00:00"
},
"modified_dateutc": "2025-07-15T14:11:02.8642242+00:00"
},
"equipment_model_id": "366dff18-a455-463b-a91c-f154b3e89824",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6fe2bb23-abc0-43f5-95a1-4666a26aa3c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e393373d-8835-45cf-96d3-9da6494a8d9d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c5f6a3cb-8172-4191-9a0b-b4f3ab8aae46",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d7a0b71e-b638-4d88-8b83-856ae071d6cc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0f374085-0278-44ee-840e-d329260f3ddc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4240000-b65a-4b9e-abf1-c6558fc61706",
"db_currency_id": "7b832707-1395-4d9c-a8dc-0395c282c5df",
"db_language_id": "dd84a62a-b726-40d8-93ba-3b8137bda140",
"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-07-15T14:11:02.8642242+00:00"
},
"modified_dateutc": "2025-07-15T14:11:02.8798536+00:00"
},
"equipment_family_id": "bc0845e3-2e6c-43bd-9e71-6ad7ea6112f4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c5a9f4c9-d983-4941-bb07-b97e0d565178",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dc40fcb2-ec0a-495e-a7bf-8c8df570a67c",
"_parent_code": "sample string 6",
"sales_organization_id": "0c08fc0d-055b-4014-ad14-909a43a80291",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0f374085-0278-44ee-840e-d329260f3ddc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4240000-b65a-4b9e-abf1-c6558fc61706",
"db_currency_id": "7b832707-1395-4d9c-a8dc-0395c282c5df",
"db_language_id": "dd84a62a-b726-40d8-93ba-3b8137bda140",
"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-07-15T14:11:02.8642242+00:00"
},
"modified_dateutc": "2025-07-15T14:11:02.8642242+00:00"
},
"date_in_production_since": "2025-07-15T14:11:02.8798536+00:00",
"date_out_of_production_since": "2025-07-15T14:11:02.8798536+00:00",
"date_end_support": "2025-07-15T14:11:02.8798536+00:00",
"sales_organization_id": "a1399455-929d-43ed-9c2f-9eed6f9ac82b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0f374085-0278-44ee-840e-d329260f3ddc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4240000-b65a-4b9e-abf1-c6558fc61706",
"db_currency_id": "7b832707-1395-4d9c-a8dc-0395c282c5df",
"db_language_id": "dd84a62a-b726-40d8-93ba-3b8137bda140",
"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-07-15T14:11:02.8642242+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-07-15T14:11:02.8798536+00:00"
},
"project_status_id": "2ba6fdd1-e2e1-4861-99bb-c9466c90ea88",
"project_status_code": "sample string 10",
"project_status": {
"id": "61b7ac28-3cd9-4706-9240-2cdbb4718eeb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2a5bea67-e4be-4ea3-9ec1-0765ac0fe3fb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0f374085-0278-44ee-840e-d329260f3ddc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4240000-b65a-4b9e-abf1-c6558fc61706",
"db_currency_id": "7b832707-1395-4d9c-a8dc-0395c282c5df",
"db_language_id": "dd84a62a-b726-40d8-93ba-3b8137bda140",
"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-07-15T14:11:02.8642242+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-15T14:11:02.8798536+00:00"
},
"company_id": "2da955ae-a92e-4c4f-83d4-56169538f68b",
"company_code": "sample string 12",
"db_address_id": "8b324e6a-9cc8-42c0-8852-1375e48cd3e1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1821c189-0779-4e35-8c7f-144fc14ad91a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5df812d1-625a-4a91-a34d-9d4e318a949a",
"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-07-15T14:11:02.8798536+00:00",
"date_create": "2025-07-15T14:11:02.8798536+00:00",
"date_update": "2025-07-15T14:11:02.8798536+00:00",
"updated_by_user_id": "fc98e6c0-8412-463d-bec7-39c5e6296861",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-07-15T14:11:02.8798536+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-07-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-07-15T14:11:02.8798536+00:00",
"date_last_job": "2025-07-15T14:11:02.8798536+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-07-15T14:11:02.8798536+00:00",
"modified_dateutc": "2025-07-15T14:11:02.8798536+00:00",
"is_mobile_installation": true
},
"job_type_id": "c6ed19f2-5dcf-4a17-948e-bae91ed893c6",
"job_type_code": "sample string 7",
"job_type": {
"id": "8802aa9b-ba6c-4bdf-8bde-1bcf993a729b",
"name": "sample string 2",
"sales_organization_id": "acb978dd-9531-4136-b283-0f0a6fdfc135",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-07-15T14:11:02.8798536+00:00",
"code": "sample string 7"
},
"job_priority_id": "a110f280-2181-406c-9cbe-93fac874416c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "89cc681e-9b20-471e-b787-cd13147ae131",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "20996b48-fe0c-43bd-b64b-5857fcef1834",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0f374085-0278-44ee-840e-d329260f3ddc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4240000-b65a-4b9e-abf1-c6558fc61706",
"db_currency_id": "7b832707-1395-4d9c-a8dc-0395c282c5df",
"db_language_id": "dd84a62a-b726-40d8-93ba-3b8137bda140",
"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-07-15T14:11:02.8642242+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-15T14:11:02.8798536+00:00"
},
"job_status_id": "fe1394b5-f4fc-46f2-9efd-431db99c77a4",
"job_status_code": "sample string 11",
"db_address_id": "d438ba8d-e3ad-41eb-84ce-ffccba173e11",
"contact_id": "b57c1d58-1cc1-44b6-b3b8-a19b7ae7c6da",
"requested_by_company_id": "45f696a2-57ab-496b-9efa-cabf934040dd",
"requested_by_contact_id": "1d0f326f-7c25-4212-a7dc-ddd03aa3f8a3",
"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-07-15T14:11:02.8798536+00:00",
"due_date": "2025-07-15T14:11:02.8798536+00:00",
"date_create": "2025-07-15T14:11:02.8798536+00:00",
"date_update": "2025-07-15T14:11:02.8798536+00:00",
"date_closed": "2025-07-15T14:11:02.8798536+00:00",
"suggested_user_id": "317a01df-eaae-421d-a75f-7ab5f535ce72",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "95681522-baf3-4fb3-9bfe-ca9e16cbc65b",
"db_language_id": "2a211417-0523-4bd2-9e05-af7abc1bc4cd",
"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-07-15T14:11:02.8798536+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "236c8554-b0fb-427e-993c-912beba011c7",
"sales_organization": {
"id": "0f374085-0278-44ee-840e-d329260f3ddc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4240000-b65a-4b9e-abf1-c6558fc61706",
"db_currency_id": "7b832707-1395-4d9c-a8dc-0395c282c5df",
"db_language_id": "dd84a62a-b726-40d8-93ba-3b8137bda140",
"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-07-15T14:11:02.8642242+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bb5e4a6b-16ee-4304-a7e0-e0920629b807",
"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": "31bce607-591a-41e5-a1d7-364323b4fbde",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-07-15T14:11:02.8798536+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4d90aa21-c9a3-43cd-a0df-9be3383019d1"
},
"suggested_date_start": "2025-07-15T14:11:02.8798536+00:00",
"skill_id": "312eb7a0-4be9-439a-b756-d947433251e4",
"skill_code": "sample string 32",
"skill": {
"id": "b7b84c57-cd74-47aa-a51f-76df461b9a3a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "86576c8e-02cf-44d9-8eca-5790057a5b22",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0f374085-0278-44ee-840e-d329260f3ddc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a4240000-b65a-4b9e-abf1-c6558fc61706",
"db_currency_id": "7b832707-1395-4d9c-a8dc-0395c282c5df",
"db_language_id": "dd84a62a-b726-40d8-93ba-3b8137bda140",
"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-07-15T14:11:02.8642242+00:00"
},
"modified_dateutc": "2025-07-15T14:11:02.8798536+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cddc73e1-2615-4ee2-91cb-420bdaacd1dc",
"date_reported_by_company": "2025-07-15T14:11:02.8798536+00:00",
"id2": 36,
"company_id": "bd32cb1b-d743-466c-829b-567a6bcaa514",
"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": "31ecdf95-97b2-4e82-8810-2043a0a89d64",
"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-07-15T14:11:02.8798536+00:00"
},
"work_instruction_details_id": "7ec7f8d3-7661-4239-80db-65511f96c393",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "32dfea63-92bc-4bc4-a779-1ecef29bdce5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "646dc7b1-e915-4490-bb23-bba2f17dd06e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-07-15T14:11:02.8798536+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": "15ed7c22-051f-4e05-b7c6-c9a2da96d9e6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-07-15T14:11:02.8798536+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.