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": "4cbc23e5-9044-4337-b90e-4318da999aa8",
"jobs_id": "cabc0dc3-c2c7-4fa6-8cd0-a6116fcbf806",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2626196d-625e-41cf-80de-1afcd7d9b817",
"_parent_id": "e0ff2cf8-85bc-468c-9589-205834560997",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0d344780-e443-4861-a577-10f223a7c2a0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2747b89c-912e-4ad8-a721-727f810cedf1",
"_parent_id": "373cdc1a-5b00-4472-9c07-5d76fbe527f6",
"root_parent_id": "45637b70-b3dd-4714-a7b0-e70b3c0404cf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8a52c48c-d7da-4a9b-90b8-070c1b2856f2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b9ccdf0e-f639-41e7-9067-54e779da7ec7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e35a425d-2a66-47c4-b79e-4862027dbc16",
"_parent_code": "sample string 6",
"sales_organization_id": "da353c08-c2cd-4f89-9816-b2375506341a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f1936e12-4f16-44d9-a731-da7d8cf3b4c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfcacc78-e543-4115-bdf1-c7496282b3ce",
"db_currency_id": "5cea1e0c-8bdc-47ed-a612-739a88de05d2",
"db_language_id": "cbe2a639-5c2e-4cd3-828c-6be78ea0e5db",
"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-03-31T13:23:35.1708153+00:00"
},
"modified_dateutc": "2025-03-31T13:23:35.1708153+00:00"
},
"equipment_model_id": "07d9017b-71e1-4155-8d12-5e3feb79f10f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e95cb3ed-b018-4be1-b918-d543c379e2bb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ddc9a15a-6e49-41d6-a52c-b84b0164fd4a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c0a20625-12b2-44c7-94f3-f1076c8c63fe",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9cf1ac50-ae0a-4e67-b4b0-01ad64802aca",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f1936e12-4f16-44d9-a731-da7d8cf3b4c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfcacc78-e543-4115-bdf1-c7496282b3ce",
"db_currency_id": "5cea1e0c-8bdc-47ed-a612-739a88de05d2",
"db_language_id": "cbe2a639-5c2e-4cd3-828c-6be78ea0e5db",
"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-03-31T13:23:35.1708153+00:00"
},
"modified_dateutc": "2025-03-31T13:23:35.1708153+00:00"
},
"equipment_family_id": "318350fc-9f59-4278-a44d-b6580ba6ceb5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b9ccdf0e-f639-41e7-9067-54e779da7ec7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e35a425d-2a66-47c4-b79e-4862027dbc16",
"_parent_code": "sample string 6",
"sales_organization_id": "da353c08-c2cd-4f89-9816-b2375506341a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f1936e12-4f16-44d9-a731-da7d8cf3b4c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfcacc78-e543-4115-bdf1-c7496282b3ce",
"db_currency_id": "5cea1e0c-8bdc-47ed-a612-739a88de05d2",
"db_language_id": "cbe2a639-5c2e-4cd3-828c-6be78ea0e5db",
"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-03-31T13:23:35.1708153+00:00"
},
"modified_dateutc": "2025-03-31T13:23:35.1708153+00:00"
},
"date_in_production_since": "2025-03-31T13:23:35.1708153+00:00",
"date_out_of_production_since": "2025-03-31T13:23:35.1708153+00:00",
"date_end_support": "2025-03-31T13:23:35.1708153+00:00",
"sales_organization_id": "ef6e4456-6d55-4468-881c-04149c3ae748",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f1936e12-4f16-44d9-a731-da7d8cf3b4c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfcacc78-e543-4115-bdf1-c7496282b3ce",
"db_currency_id": "5cea1e0c-8bdc-47ed-a612-739a88de05d2",
"db_language_id": "cbe2a639-5c2e-4cd3-828c-6be78ea0e5db",
"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-03-31T13:23:35.1708153+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-03-31T13:23:35.1708153+00:00"
},
"project_status_id": "616646d1-0a93-40e4-a904-59b25abcb38b",
"project_status_code": "sample string 10",
"project_status": {
"id": "59f8fd58-d9f4-4c00-ad26-5ca349709e98",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e6012c3b-b78c-4d84-b587-19fb20329435",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f1936e12-4f16-44d9-a731-da7d8cf3b4c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfcacc78-e543-4115-bdf1-c7496282b3ce",
"db_currency_id": "5cea1e0c-8bdc-47ed-a612-739a88de05d2",
"db_language_id": "cbe2a639-5c2e-4cd3-828c-6be78ea0e5db",
"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-03-31T13:23:35.1708153+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-31T13:23:35.1708153+00:00"
},
"company_id": "86ff0d65-7744-48df-af76-7352d13911c9",
"company_code": "sample string 12",
"db_address_id": "7eb0f7db-d5c5-4db0-b1df-ec67109ad2f8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d25f3d4f-f318-481f-b3d9-3a876ded682f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e580c115-ed43-455d-9fb5-cfc0b311c13c",
"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-03-31T13:23:35.1708153+00:00",
"date_create": "2025-03-31T13:23:35.1708153+00:00",
"date_update": "2025-03-31T13:23:35.1708153+00:00",
"updated_by_user_id": "bd6e83f2-44c3-48b1-8d9e-ccfd9b7c2c50",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-03-31T13:23:35.1708153+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-03-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-03-31T13:23:35.1708153+00:00",
"date_last_job": "2025-03-31T13:23:35.1708153+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-03-31T13:23:35.1708153+00:00",
"modified_dateutc": "2025-03-31T13:23:35.1708153+00:00",
"is_mobile_installation": true
},
"job_type_id": "c9d48c93-81f0-48f4-ae1b-782623c4379d",
"job_type_code": "sample string 7",
"job_type": {
"id": "9bcc9405-f3a6-4815-8946-327639581112",
"name": "sample string 2",
"sales_organization_id": "06044279-cf9b-4099-aa23-24a6d00e70b1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-03-31T13:23:35.1708153+00:00",
"code": "sample string 7"
},
"job_priority_id": "93f0689e-2067-489f-b554-476242426a13",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "321cd6c3-fde5-4ab2-9c99-811c0cc5dd2d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "df92942c-416b-4445-9194-318b2a7f11b6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f1936e12-4f16-44d9-a731-da7d8cf3b4c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfcacc78-e543-4115-bdf1-c7496282b3ce",
"db_currency_id": "5cea1e0c-8bdc-47ed-a612-739a88de05d2",
"db_language_id": "cbe2a639-5c2e-4cd3-828c-6be78ea0e5db",
"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-03-31T13:23:35.1708153+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-31T13:23:35.1708153+00:00"
},
"job_status_id": "46f4ad2d-23c8-4232-8753-11ddb2f58541",
"job_status_code": "sample string 11",
"db_address_id": "f25e86ae-8ec0-4ec5-84be-23fd05fb7b61",
"contact_id": "d54744d5-2788-4fc6-b850-f42fec8ca4fc",
"requested_by_company_id": "130f4e43-daa9-4cf0-81dd-ea8a6186a886",
"requested_by_contact_id": "796309cc-001c-460a-963a-639ecc9ef79e",
"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-03-31T13:23:35.1708153+00:00",
"due_date": "2025-03-31T13:23:35.1708153+00:00",
"date_create": "2025-03-31T13:23:35.1708153+00:00",
"date_update": "2025-03-31T13:23:35.1708153+00:00",
"date_closed": "2025-03-31T13:23:35.1708153+00:00",
"suggested_user_id": "e06dbb01-6bf4-40db-bb65-d8694e3ae54a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "aa7c2984-a3f7-432b-b343-41b4c87c4bb4",
"db_language_id": "0dee634b-1a4e-4ee2-9c69-68574267ab06",
"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-03-31T13:23:35.1708153+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "19fefb94-eb48-4adc-8509-7f24b37aff63",
"sales_organization": {
"id": "f1936e12-4f16-44d9-a731-da7d8cf3b4c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfcacc78-e543-4115-bdf1-c7496282b3ce",
"db_currency_id": "5cea1e0c-8bdc-47ed-a612-739a88de05d2",
"db_language_id": "cbe2a639-5c2e-4cd3-828c-6be78ea0e5db",
"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-03-31T13:23:35.1708153+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4da26194-1c2a-43cf-8681-c46a2cff9c87",
"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": "3baa354f-6d17-42b5-a3eb-7f353eedd3cf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-03-31T13:23:35.1708153+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "58020311-01ed-4bde-8c59-d0eb3757f603"
},
"suggested_date_start": "2025-03-31T13:23:35.1708153+00:00",
"skill_id": "b251b75c-f8be-478c-8ed1-cd70ba773ae6",
"skill_code": "sample string 32",
"skill": {
"id": "287d592f-3dcd-4de7-81c6-ade7d59783f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "63a27754-d8b4-4d2b-87c9-99dbe26a4e59",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f1936e12-4f16-44d9-a731-da7d8cf3b4c1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cfcacc78-e543-4115-bdf1-c7496282b3ce",
"db_currency_id": "5cea1e0c-8bdc-47ed-a612-739a88de05d2",
"db_language_id": "cbe2a639-5c2e-4cd3-828c-6be78ea0e5db",
"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-03-31T13:23:35.1708153+00:00"
},
"modified_dateutc": "2025-03-31T13:23:35.1708153+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a6a099d5-b118-47da-87f2-d6c49ae0c248",
"date_reported_by_company": "2025-03-31T13:23:35.1708153+00:00",
"id2": 36,
"company_id": "7a028149-d0c2-480f-8081-48c76789baa7",
"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": "01b529ba-c2f1-45c3-9709-2b9249389b83",
"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-03-31T13:23:35.1708153+00:00"
},
"work_instruction_details_id": "eb2bb23f-7df3-4dda-b03c-bc08de1b8066",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d430700a-15d7-4142-b97c-3669f16a8487",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e5b35073-c77b-4327-a815-a5c4b2f3e337",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-03-31T13:23:35.1708153+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": "e7061f1a-607f-4bca-b120-ae52e40f7180",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-03-31T13:23:35.1708153+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.