Creates a new job work instruction list.

Request Information

URI Parameters :

None.

Body Parameters :

job_work_instruction_list
NameDescriptionTypeAdditional 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": "8b805978-1d23-4367-846b-9e4563fadc83",
  "jobs_id": "0bcf1b1e-80f7-4af1-a8a5-599d908e584f",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "ed56e747-4abf-4b29-be87-f6590bd1a6f5",
    "_parent_id": "85f9ac2a-25ce-4947-a8c4-af524e7c5ab8",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "134147b1-8071-4dc6-acd8-d4454704c301",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "471ad618-d7d2-413a-87de-73b23275e2c8",
      "_parent_id": "f66bc2e4-a99a-4182-985e-06c45873db78",
      "root_parent_id": "63f2456c-b521-4b7b-9f2b-94ca37aa3d27",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "4769b821-a47f-402c-8006-d87573a33fe3",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "2151a36c-49cb-407a-b62d-66ed645d9350",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "5493523c-96e3-4abc-b251-f8972501d81c",
        "_parent_code": "sample string 6",
        "sales_organization_id": "b3878f05-95b4-40f1-851a-aaba419c11da",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "28240438-d894-47ad-a3d9-eba1d8d24e48",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "7dc8ce2e-2f4f-4483-9416-c1a231e74626",
          "db_currency_id": "d1933f73-2368-4ac3-a43a-8bff8f37229a",
          "db_language_id": "09f86af4-1fe4-4355-8ad6-38be31170952",
          "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": "2024-04-15T10:57:15.2075416+00:00"
        },
        "modified_dateutc": "2024-04-15T10:57:15.2075416+00:00"
      },
      "equipment_model_id": "1fe8664a-f3fa-4275-bab8-48502e486894",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "4a5e4adc-f64e-48f0-95f6-0895d960f518",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "09de8cfe-2e1d-49bc-a9c0-ce3761126e3c",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "ec04610d-5ba2-4d23-a559-f4de98df8443",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "bfe16dc5-48dd-4193-b8d2-75c1ca17f986",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "28240438-d894-47ad-a3d9-eba1d8d24e48",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "7dc8ce2e-2f4f-4483-9416-c1a231e74626",
            "db_currency_id": "d1933f73-2368-4ac3-a43a-8bff8f37229a",
            "db_language_id": "09f86af4-1fe4-4355-8ad6-38be31170952",
            "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": "2024-04-15T10:57:15.2075416+00:00"
          },
          "modified_dateutc": "2024-04-15T10:57:15.2075416+00:00"
        },
        "equipment_family_id": "a4487652-b0e5-427a-9112-cb85abee4038",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "2151a36c-49cb-407a-b62d-66ed645d9350",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "5493523c-96e3-4abc-b251-f8972501d81c",
          "_parent_code": "sample string 6",
          "sales_organization_id": "b3878f05-95b4-40f1-851a-aaba419c11da",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "28240438-d894-47ad-a3d9-eba1d8d24e48",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "7dc8ce2e-2f4f-4483-9416-c1a231e74626",
            "db_currency_id": "d1933f73-2368-4ac3-a43a-8bff8f37229a",
            "db_language_id": "09f86af4-1fe4-4355-8ad6-38be31170952",
            "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": "2024-04-15T10:57:15.2075416+00:00"
          },
          "modified_dateutc": "2024-04-15T10:57:15.2075416+00:00"
        },
        "date_in_production_since": "2024-04-15T10:57:15.2075416+00:00",
        "date_out_of_production_since": "2024-04-15T10:57:15.2075416+00:00",
        "date_end_support": "2024-04-15T10:57:15.2075416+00:00",
        "sales_organization_id": "982452ab-7ec4-4a0c-894d-ae6b8e4af1b8",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "28240438-d894-47ad-a3d9-eba1d8d24e48",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "7dc8ce2e-2f4f-4483-9416-c1a231e74626",
          "db_currency_id": "d1933f73-2368-4ac3-a43a-8bff8f37229a",
          "db_language_id": "09f86af4-1fe4-4355-8ad6-38be31170952",
          "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": "2024-04-15T10:57:15.2075416+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": "2024-04-15T10:57:15.2075416+00:00"
      },
      "project_status_id": "3f699a99-58fb-4f61-bb24-969ef7a9a2b1",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "1102a8a9-3f94-4fcd-9b70-63478556e905",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "d3dce7a2-d64a-4611-9396-a512883a3fb4",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "28240438-d894-47ad-a3d9-eba1d8d24e48",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "7dc8ce2e-2f4f-4483-9416-c1a231e74626",
          "db_currency_id": "d1933f73-2368-4ac3-a43a-8bff8f37229a",
          "db_language_id": "09f86af4-1fe4-4355-8ad6-38be31170952",
          "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": "2024-04-15T10:57:15.2075416+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2024-04-15T10:57:15.2075416+00:00"
      },
      "company_id": "3bd6f0f0-d9f2-4a4d-93ce-ac1aff727404",
      "company_code": "sample string 12",
      "db_address_id": "7f9baa1c-7e5d-4141-8244-a385b9028a70",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "117b8ef7-8497-4248-a605-b8dd55b12cd8",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "0815d775-752c-4a67-bc19-6e3fe1012d36",
      "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": "2024-04-15T10:57:15.2075416+00:00",
      "date_create": "2024-04-15T10:57:15.2075416+00:00",
      "date_update": "2024-04-15T10:57:15.2075416+00:00",
      "updated_by_user_id": "22c8170e-9ff7-47ee-9cf2-5d41d8e75d28",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2024-04-15T10:57:15.2075416+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": "2024-04-15T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2024-04-15T10:57:15.2075416+00:00",
      "date_last_job": "2024-04-15T10:57:15.2075416+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2024-04-15T10:57:15.2075416+00:00",
      "modified_dateutc": "2024-04-15T10:57:15.2075416+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "c5343eec-892d-4af4-b705-1389ae5d7c1b",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "576119b9-f83e-4c2d-97b5-91cce5202ce9",
      "name": "sample string 2",
      "sales_organization_id": "d631628a-dcea-480f-a5b3-dff0481b28b9",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2024-04-15T10:57:15.2075416+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "650d52ba-6a85-4767-987a-9f382ab7f996",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "ebcd29ce-bbca-473e-a8f0-49d32726e865",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "acf93705-c89f-4bad-851d-3a37113b3924",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "28240438-d894-47ad-a3d9-eba1d8d24e48",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "7dc8ce2e-2f4f-4483-9416-c1a231e74626",
        "db_currency_id": "d1933f73-2368-4ac3-a43a-8bff8f37229a",
        "db_language_id": "09f86af4-1fe4-4355-8ad6-38be31170952",
        "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": "2024-04-15T10:57:15.2075416+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2024-04-15T10:57:15.2075416+00:00"
    },
    "job_status_id": "fdde4b29-e652-4932-b617-bde0a8762bdd",
    "job_status_code": "sample string 11",
    "db_address_id": "e97dbd6d-6504-44dc-bc66-3a977045abf7",
    "contact_id": "c4d659db-1a0f-4c21-b679-94c224b74f9b",
    "requested_by_company_id": "f30300b1-6e60-49db-8f32-f016fb133abb",
    "requested_by_contact_id": "dc5a41b6-de17-4473-b7a0-ed42e17919b4",
    "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": "2024-04-15T10:57:15.2075416+00:00",
    "due_date": "2024-04-15T10:57:15.2075416+00:00",
    "date_create": "2024-04-15T10:57:15.2075416+00:00",
    "date_update": "2024-04-15T10:57:15.2075416+00:00",
    "date_closed": "2024-04-15T10:57:15.2075416+00:00",
    "suggested_user_id": "f86352b2-5cf8-415b-9bdf-43dbacf25e93",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "3c7c6f2d-db81-40ee-973d-fc8132034b38",
      "db_language_id": "ecd824dc-3ba1-4c41-a510-0f6dfa7da1e3",
      "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": "2024-04-15T10:57:15.2075416+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "666489ea-8e03-4925-b936-bd8711e1cfee",
      "sales_organization": {
        "id": "28240438-d894-47ad-a3d9-eba1d8d24e48",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "7dc8ce2e-2f4f-4483-9416-c1a231e74626",
        "db_currency_id": "d1933f73-2368-4ac3-a43a-8bff8f37229a",
        "db_language_id": "09f86af4-1fe4-4355-8ad6-38be31170952",
        "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": "2024-04-15T10:57:15.2075416+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "fa6f491f-5284-4b37-a5b6-01c80df09beb",
      "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": "68440492-a79f-494a-877b-8d29c32deec7",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2024-04-15T10:57:15.2075416+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "5216ec85-015d-4f59-908e-3e331e315432"
    },
    "suggested_date_start": "2024-04-15T10:57:15.2075416+00:00",
    "skill_id": "d6525438-6a9e-48bb-83e9-9c9661f9a4ed",
    "skill_code": "sample string 32",
    "skill": {
      "id": "cb99a2a6-8ddc-4191-af92-5ffc9a6d179a",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "8b1308f9-f54f-4617-8d65-84b7531167b4",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "28240438-d894-47ad-a3d9-eba1d8d24e48",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "7dc8ce2e-2f4f-4483-9416-c1a231e74626",
        "db_currency_id": "d1933f73-2368-4ac3-a43a-8bff8f37229a",
        "db_language_id": "09f86af4-1fe4-4355-8ad6-38be31170952",
        "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": "2024-04-15T10:57:15.2075416+00:00"
      },
      "modified_dateutc": "2024-04-15T10:57:15.2075416+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "e0bf16ff-602d-4ef0-bafa-381dc9ea1171",
    "date_reported_by_company": "2024-04-15T10:57:15.2075416+00:00",
    "id2": 36,
    "company_id": "a0db8feb-3254-492d-8fa1-c665c13e0a2a",
    "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": "c15e4a58-db84-4893-93d0-684749d756b3",
    "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": "2024-04-15T10:57:15.2075416+00:00"
  },
  "work_instruction_details_id": "0f6302c4-80ff-468a-a0ea-668406ffc753",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "e51fd9bc-9f0d-45f4-876a-1f5520b5e42d",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "b52a9e9b-f67f-4843-83e5-1b55cef1cbe7",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2024-04-15T10:57:15.2075416+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": "01fd5270-ae38-481f-ace0-99beeef04b63",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2024-04-15T10:57:15.2075416+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.