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": "6480419c-ca06-471e-8b94-0fe40d6c057e",
"jobs_id": "2e26db54-3133-4ce0-82ac-6578429a60e3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5c9b75f9-0cdb-4884-9e2d-62de56c90edd",
"_parent_id": "2e832cd5-d805-4d62-8b47-009ed6c6c1df",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6fbeb4a0-69fd-41d9-9e35-952918d3ae30",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f4bb531b-a180-4bba-b617-683c9bc7edf3",
"_parent_id": "b7d22282-0eb0-4eb8-882c-d77a9bc7ac48",
"root_parent_id": "ebe714b9-8263-4582-a0b2-8c6fd64e6bd2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c6b2f54a-5a00-4fb0-b9bf-50433c628019",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "20a38285-0dbc-4bcd-84f7-d5fe4a90d9c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c0725c3e-5da2-4a89-9a9f-58da84bbfa30",
"_parent_code": "sample string 6",
"sales_organization_id": "45e851c3-c807-41d4-a5c4-9650f9778f35",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2a205c27-e4cf-49c2-a6bb-dc89368d679d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cec2aed6-826e-49a2-b34e-fdb52c788c86",
"db_currency_id": "030cb77b-b65d-4244-a222-f949aeb0fd8f",
"db_language_id": "f79dcae8-3c70-4a72-a582-423fb7168dbd",
"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": "2022-12-06T05:17:31.408076+01:00"
},
"modified_dateutc": "2022-12-06T05:17:31.408076+01:00"
},
"equipment_model_id": "61bfaa0b-51b4-450b-8ad5-8e4b58f9344f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "59c6d241-1ac2-404e-8e0d-3d093a965b30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4416d903-fbcf-43ec-8602-e5bd23049b3d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "306b935a-ca0c-4ae9-8911-aebc6654c639",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "32ab906a-aa9d-41e5-86bf-c783256410d2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2a205c27-e4cf-49c2-a6bb-dc89368d679d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cec2aed6-826e-49a2-b34e-fdb52c788c86",
"db_currency_id": "030cb77b-b65d-4244-a222-f949aeb0fd8f",
"db_language_id": "f79dcae8-3c70-4a72-a582-423fb7168dbd",
"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": "2022-12-06T05:17:31.408076+01:00"
},
"modified_dateutc": "2022-12-06T05:17:31.408076+01:00"
},
"equipment_family_id": "aeb4917c-fd19-4f9c-b5a4-78fab8059c6a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "20a38285-0dbc-4bcd-84f7-d5fe4a90d9c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c0725c3e-5da2-4a89-9a9f-58da84bbfa30",
"_parent_code": "sample string 6",
"sales_organization_id": "45e851c3-c807-41d4-a5c4-9650f9778f35",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2a205c27-e4cf-49c2-a6bb-dc89368d679d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cec2aed6-826e-49a2-b34e-fdb52c788c86",
"db_currency_id": "030cb77b-b65d-4244-a222-f949aeb0fd8f",
"db_language_id": "f79dcae8-3c70-4a72-a582-423fb7168dbd",
"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": "2022-12-06T05:17:31.408076+01:00"
},
"modified_dateutc": "2022-12-06T05:17:31.408076+01:00"
},
"date_in_production_since": "2022-12-06T05:17:31.408076+01:00",
"date_out_of_production_since": "2022-12-06T05:17:31.408076+01:00",
"date_end_support": "2022-12-06T05:17:31.408076+01:00",
"sales_organization_id": "0afc0087-147d-40d8-aef6-8193beff53f5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2a205c27-e4cf-49c2-a6bb-dc89368d679d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cec2aed6-826e-49a2-b34e-fdb52c788c86",
"db_currency_id": "030cb77b-b65d-4244-a222-f949aeb0fd8f",
"db_language_id": "f79dcae8-3c70-4a72-a582-423fb7168dbd",
"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": "2022-12-06T05:17:31.408076+01: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": "2022-12-06T05:17:31.408076+01:00"
},
"project_status_id": "f7d299cd-18e4-4c1a-adc9-c4e69c3f2dd2",
"project_status_code": "sample string 10",
"project_status": {
"id": "a0f2f672-6ad7-4121-9659-3f2a4384efa6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fc70e0f1-c2bf-4249-8778-faa67112c9a6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2a205c27-e4cf-49c2-a6bb-dc89368d679d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cec2aed6-826e-49a2-b34e-fdb52c788c86",
"db_currency_id": "030cb77b-b65d-4244-a222-f949aeb0fd8f",
"db_language_id": "f79dcae8-3c70-4a72-a582-423fb7168dbd",
"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": "2022-12-06T05:17:31.408076+01:00"
},
"code": "sample string 7",
"modified_dateutc": "2022-12-06T05:17:31.408076+01:00"
},
"company_id": "3a128674-97c8-4c61-9986-13aa247ed9b0",
"company_code": "sample string 12",
"db_address_id": "dfd006e0-6f70-449d-9c8b-a327478ffe31",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1cc0351e-0254-479a-8e02-4b6ec46b7423",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c5dc5470-6447-4494-a692-4d2d8f7d3f1d",
"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": "2022-12-06T05:17:31.408076+01:00",
"date_create": "2022-12-06T05:17:31.408076+01:00",
"date_update": "2022-12-06T05:17:31.408076+01:00",
"updated_by_user_id": "49ab56e7-c87d-45cb-9aec-0dc22958e9ac",
"customer_reference": "sample string 28",
"warranty_date_until": "2022-12-06T05:17:31.408076+01: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": "2022-12-06T00:00:00+01:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2022-12-06T05:17:31.408076+01:00",
"date_last_job": "2022-12-06T05:17:31.408076+01:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2022-12-06T05:17:31.408076+01:00",
"modified_dateutc": "2022-12-06T05:17:31.408076+01:00",
"is_mobile_installation": true
},
"job_type_id": "85ba94b6-6f6e-4d53-940e-800cd1b339f5",
"job_type_code": "sample string 7",
"job_type": {
"id": "2bbc34fb-ac80-43ae-80f1-1c47309b9bc7",
"name": "sample string 2",
"sales_organization_id": "ec9bfde6-b645-4113-8b92-6bc9887ea158",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2022-12-06T05:17:31.408076+01:00",
"code": "sample string 7"
},
"job_priority_id": "071e7d87-85c9-4a9c-8991-9d691593a39a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "be9b8e80-396b-495c-b1df-a2cd810e0674",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2b12aaa2-8818-4e59-b4bf-8bae09392a16",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2a205c27-e4cf-49c2-a6bb-dc89368d679d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cec2aed6-826e-49a2-b34e-fdb52c788c86",
"db_currency_id": "030cb77b-b65d-4244-a222-f949aeb0fd8f",
"db_language_id": "f79dcae8-3c70-4a72-a582-423fb7168dbd",
"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": "2022-12-06T05:17:31.408076+01:00"
},
"code": "sample string 7",
"modified_dateutc": "2022-12-06T05:17:31.408076+01:00"
},
"job_status_id": "1a1fa780-7779-450b-9bf1-2f8fc8a78085",
"job_status_code": "sample string 11",
"db_address_id": "00e0c8f4-18a9-433e-8e7d-78b234992585",
"contact_id": "243403f0-bf4c-426b-bac6-abee9ca86f00",
"requested_by_company_id": "97e2fe44-2583-4329-8ba1-c7a53e72fb75",
"requested_by_contact_id": "120bcae5-f751-4362-a4a4-8347a49bd09f",
"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": "2022-12-06T05:17:31.408076+01:00",
"due_date": "2022-12-06T05:17:31.408076+01:00",
"date_create": "2022-12-06T05:17:31.408076+01:00",
"date_update": "2022-12-06T05:17:31.408076+01:00",
"date_closed": "2022-12-06T05:17:31.408076+01:00",
"suggested_user_id": "8d894730-b8a8-42e7-89fb-01ec7652ecc8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f16ed221-cff5-4fb8-9ba6-775321bb9281",
"db_language_id": "99a503d9-374b-44fe-bcb6-d2d6c543f0af",
"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": "2022-12-06T05:17:31.408076+01:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "33a60dc7-6b94-4e44-843a-28bcc5e62aae",
"sales_organization": {
"id": "2a205c27-e4cf-49c2-a6bb-dc89368d679d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cec2aed6-826e-49a2-b34e-fdb52c788c86",
"db_currency_id": "030cb77b-b65d-4244-a222-f949aeb0fd8f",
"db_language_id": "f79dcae8-3c70-4a72-a582-423fb7168dbd",
"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": "2022-12-06T05:17:31.408076+01:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bf1f9323-c590-48f0-ab3d-41b0c2f62214",
"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": "1a464eaf-7323-44c4-b35f-0a8e8851325b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2022-12-06T05:17:31.408076+01:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "10073e09-3541-49dc-b9ae-403bd33a3702"
},
"suggested_date_start": "2022-12-06T05:17:31.408076+01:00",
"skill_id": "ac8e0e4e-e193-4563-9590-3aec099c7057",
"skill_code": "sample string 32",
"skill": {
"id": "8620fe96-82f2-4691-9cfe-723a0d73e524",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7dd7b34e-b911-4b82-bcd5-77f971bacb85",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2a205c27-e4cf-49c2-a6bb-dc89368d679d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cec2aed6-826e-49a2-b34e-fdb52c788c86",
"db_currency_id": "030cb77b-b65d-4244-a222-f949aeb0fd8f",
"db_language_id": "f79dcae8-3c70-4a72-a582-423fb7168dbd",
"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": "2022-12-06T05:17:31.408076+01:00"
},
"modified_dateutc": "2022-12-06T05:17:31.408076+01:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9613abfc-024e-4801-aa76-1f2a358f478e",
"date_reported_by_company": "2022-12-06T05:17:31.408076+01:00",
"id2": 36,
"company_id": "84dc82bc-26bb-412e-96b9-d5196ea8c00f",
"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": "88d62c68-d5ea-46ef-a38d-cf279586cc68",
"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": "2022-12-06T05:17:31.408076+01:00"
},
"work_instruction_details_id": "60ddb7ae-f445-4e9e-a663-249d030de432",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0283e8f0-3889-45b7-870a-87b3072b5b99",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9f3d3a72-25a0-4e80-9aa9-550d5bea7740",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2022-12-06T05:17:31.408076+01: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": "0114a4bf-a339-49c0-bd23-df6b11881b56",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2022-12-06T05:17:31.408076+01:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.