{ "openapi":"3.0.0", "info":{ "title":"Oracle Utilities REST API for Work and Asset", "description":"This documentation helps you to get started using the REST APIs for Oracle Utilities Work and Asset Cloud Service and Oracle Utilities Work and Asset Management.", "version":"2026.03.16", "x-summary":"This documentation helps you to get started using the REST APIs for Oracle Utilities Work and Asset Cloud Service and Oracle Utilities Work and Asset Management." }, "tags":[ { "name":"Financials/Chart of Accounts", "description":"This REST service synchronizes Enterprise Resource Planning (ERP) Chart of Accounts with Work and Asset Management Cost Center and Expense Codes, by creating Work and Asset Management Cost Center Ongoing Data Synchronization objects to process the requests." }, { "name":"Financials/Create or Update Project" }, { "name":"Inventory/Manage Stock Item Detail", "description":"Stock Item Detail records defines how a stock item is managed in a storeroom. The manageStockItemDetail operation of the REST web service creates or updates these Stock Item Detail records. The inventoryAdjustment operation of the web service creates Stock Transactions when Quantity or Average Unit Price is adjusted for the Stock Item Detail." }, { "name":"Inventory/Manage Storeroom", "description":"Storerooms are locations for inventory items. This REST web service creates or updates storerooms." }, { "name":"Inventory/Material Issue", "description":"Creates Material Issue Lines from an external system. Use this service to record material issued from the storeroom for Material Requests initiated from WAM." }, { "name":"Inventory/Stock Items", "description":"A stock item sync request record manages the creation or update of a stock item." }, { "name":"Purchasing/Blanket Contract", "description":"This REST service synchronizes Enterprise Resource Planning Blanket Contracts with Work and Asset Management." }, { "name":"Purchasing/Invoicing", "description":"This REST service synchronizes Enterprise Resource Planning (ERP) Invoice and Payments with Work and Asset Management, by creating Work and Asset Management Invoice inbound integration objects." }, { "name":"Purchasing/Purchase Orders", "description":"This REST service synchronizes an Enterprise Resource Planning (ERP) Purchase Order with the Work and Asset Management Purchase Order inbound integration object." }, { "name":"Purchasing/Vendor Location Synchronization", "description":"This REST service synchronizes Enterprise Resource Planning (ERP) Suppliers with Work and Asset Management Vendor and Vendor Locations, by creating Work and Asset Management Vendor Location Data Synchronization objects." }, { "name":"Resources/Absences", "description":"This REST web service synchronizes Enterprise Resource Planning (ERP) - Human Capital Management (HCM) Absence with a Work and Asset Management Employee Unavailability. This web service creates WAM Employee Unavailability creates new or updates existing records." }, { "name":"Resources/Crafts", "description":"This REST service synchronizes Enterprise Resource Planning (ERP) - Human Capital Management (HCM) Jobs with Work and Asset Management (WAM) Crafts, by creating WAM Craft records or updating existing records." }, { "name":"Resources/Employees", "description":"This REST web service synchronizes Enterprise Resource Planning - Human Capital Management Employee records with Work and Asset Management." }, { "name":"Work/Communication", "description":"Communication logs show all the communications made against a work document. Communication logs can be linked to a variety of work records, such as work designs, work requests, work orders and service calls." }, { "name":"Work/Maintain Service Calls", "description":"Service calls enable work to be created when a call from either an internal or external resource is received by a company representative. Work records, such as work designs, work requests, work orders, and work activities, can all be created as a result of the service call." }, { "name":"Work/Service Call Maintenance", "description":"The operations from the Work/Service Call Maintenance category." }, { "name":"Work/Work Activity", "description":"A work activity is a specific task that needs to be planned, scheduled, and completed. For example, activities can be created for routine maintenance of assets or to fix or replace failed assets. The following details on the work activity control key aspects of the task. The type of work to be performed, for example whether it's routine preventive maintenance. A time window, during which the activity is preferred to be worked on. The resources, including craft, equipment, material and so on, that are required and the quantity for each resource." } ], "paths":{ "https://server:port/rest/apis/asset/inventory/materialIssue/":{ "post":{ "summary":"Create Material Issue Line", "description":"Creates Material Issue Lines from an external system. Use this service to record material issued from the storeroom for Material Requests initiated from WAM.", "operationId":"createMaterialIssue", "tags":[ "Inventory/Material Issue" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CREATEMATERIALISSUE_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CREATEMATERIALISSUE_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CREATEMATERIALISSUE_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CREATEMATERIALISSUE_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-inventory-materialIssue--post", "x-filename-id":"https-server-port-rest-apis-asset-inventory-materialissue-post" } }, "https://server:port/rest/apis/asset/inventory/stockItemDetail/":{ "post":{ "summary":"Manage Stock Item Detail", "description":"Creates or updates Stock Item Detail records.", "operationId":"manageStockItemDetail", "tags":[ "Inventory/Manage Stock Item Detail" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MANAGESTOCKITEMDETAIL_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/MANAGESTOCKITEMDETAIL_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MANAGESTOCKITEMDETAIL_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/MANAGESTOCKITEMDETAIL_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-inventory-stockItemDetail--post", "x-filename-id":"https-server-port-rest-apis-asset-inventory-stockitemdetail-post" } }, "https://server:port/rest/apis/asset/inventory/stockItemDetail/inventoryAdjustment":{ "post":{ "summary":"Add Inventory Adjustment", "description":"Creates Stock Transactions when Quantity or Average Unit Price is adjusted for the Stock Item Detail.", "operationId":"inventoryAdjustment", "tags":[ "Inventory/Manage Stock Item Detail" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/INVENTORYADJUSTMENT_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/INVENTORYADJUSTMENT_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/INVENTORYADJUSTMENT_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/INVENTORYADJUSTMENT_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-inventory-stockItemDetail-inventoryAdjustment-post", "x-filename-id":"https-server-port-rest-apis-asset-inventory-stockitemdetail-inventoryadjustment-post" } }, "https://server:port/rest/apis/asset/storeroom/":{ "post":{ "summary":"Manage Storeroom", "description":"Creates or updates storerooms.", "operationId":"manageStoreroom", "tags":[ "Inventory/Manage Storeroom" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MANAGESTOREROOM_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/MANAGESTOREROOM_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/MANAGESTOREROOM_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/MANAGESTOREROOM_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-storeroom--post", "x-filename-id":"https-server-port-rest-apis-asset-storeroom-post" } }, "https://server:port/rest/apis/asset/resources/crafts/{externalSystem}/{externalId}":{ "put":{ "summary":"Create or Update Craft", "description":"This REST service synchronizes Enterprise Resource Planning (ERP) - Human Capital Management (HCM) Jobs with Work and Asset Management (WAM) Crafts, by creating WAM Craft records or updating existing records.", "operationId":"externalUpdateAddCraft", "parameters":[ { "in":"path", "name":"externalId", "description":"A unique identifier of the leave record as represented in the external system - Human Capital Management", "example":"300000230453798", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"externalSystem", "description":"The Work and Asset Management code that represents the external system.", "example":"HCM", "required":true, "schema":{ "type":"string" } } ], "tags":[ "Resources/Crafts" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EXTERNALUPDATEADDCRAFT_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/EXTERNALUPDATEADDCRAFT_request/properties/W1UpdAdCraft" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EXTERNALUPDATEADDCRAFT_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/EXTERNALUPDATEADDCRAFT_response/properties/W1UpdAdCraft" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EXTERNALUPDATEADDCRAFT_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/EXTERNALUPDATEADDCRAFT_error/properties/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EXTERNALUPDATEADDCRAFT_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/EXTERNALUPDATEADDCRAFT_error/properties/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-resources-crafts-{externalSystem}-{externalId}-put", "x-filename-id":"https-server-port-rest-apis-asset-resources-crafts-externalsystem-externalid-put" } }, "https://server:port/rest/apis/asset/purchasing/blanketContractSynchronization/":{ "post":{ "summary":"Synchronize Blanket Contract", "description":"This REST service synchronizes Enterprise Resource Planning Blanket Contracts with Work and Asset Management.", "operationId":"syncBlanketContract", "tags":[ "Purchasing/Blanket Contract" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCBLANKETCONTRACT_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCBLANKETCONTRACT_request/properties/W1BlnktSyn" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCBLANKETCONTRACT_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCBLANKETCONTRACT_response/properties/W1BlnktSyn" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCBLANKETCONTRACT_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCBLANKETCONTRACT_error/properties/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCBLANKETCONTRACT_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCBLANKETCONTRACT_error/properties/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-purchasing-blanketContractSynchronization--post", "x-filename-id":"https-server-port-rest-apis-asset-purchasing-blanketcontractsynchronization-post" } }, "https://server:port/rest/apis/asset/financials/chartOfAccountsSynchronization/":{ "post":{ "summary":"Synchronize Chart of Accounts", "description":"This REST service synchronizes Enterprise Resource Planning (ERP) Chart of Accounts with Work and Asset Management Cost Center and Expense Codes, by creating Work and Asset Management Cost Center Ongoing Data Synchronization objects to process the requests.", "operationId":"syncChartOfAccounts", "tags":[ "Financials/Chart of Accounts" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1ChrtActSyn_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1ChrtActSyn_request/properties/W1ChrtActSyn" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1ChrtActSyn_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1ChrtActSyn_response/properties/W1ChrtActSyn" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1ChrtActSyn_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1ChrtActSyn_error/properties/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1ChrtActSyn_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1ChrtActSyn_error/properties/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-financials-chartOfAccountsSynchronization--post", "x-filename-id":"https-server-port-rest-apis-asset-financials-chartofaccountssynchronization-post" } }, "https://server:port/rest/apis/asset/purchasing/purchaseOrderSynchronization/":{ "post":{ "summary":"Synchronize Purchase Order", "description":"This REST service synchronizes an Enterprise Resource Planning (ERP) Purchase Order with the Work and Asset Management Purchase Order inbound integration object.", "operationId":"syncPurchaseOrder", "tags":[ "Purchasing/Purchase Orders" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCPURCHASEORDER_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCPURCHASEORDER_request/properties/W1PurOrdSync" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCPURCHASEORDER_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCPURCHASEORDER_response/properties/W1PurOrdSync" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCPURCHASEORDER_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCPURCHASEORDER_error/properties/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCPURCHASEORDER_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCPURCHASEORDER_error/properties/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-purchasing-purchaseOrderSynchronization--post", "x-filename-id":"https-server-port-rest-apis-asset-purchasing-purchaseordersynchronization-post" } }, "https://server:port/rest/apis/asset/inventory/stockItemSync/sync":{ "post":{ "summary":"Synchronize Stock Item", "description":"A stock item sync request record manages the creation or update of a stock item.", "operationId":"sync", "tags":[ "Inventory/Stock Items" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1AdStkItmSy_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1AdStkItmSy_request/properties/W1AdStkItmSy" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1AdStkItmSy_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1AdStkItmSy_response/properties/W1AdStkItmSy" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1AdStkItmSy_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1AdStkItmSy_error/properties/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1AdStkItmSy_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1AdStkItmSy_error/properties/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-inventory-stockItemSync-sync-post", "x-filename-id":"https-server-port-rest-apis-asset-inventory-stockitemsync-sync-post" } }, "https://server:port/rest/apis/asset/resources/leave/{externalId}":{ "put":{ "summary":"Create or Update Leave", "description":"This REST web service synchronizes Enterprise Resource Planning (ERP) - Human Capital Management (HCM) Absence with a Work and Asset Management Employee Unavailability. This web service creates WAM Employee Unavailability creates new or updates existing records.", "operationId":"updateAddLeave", "parameters":[ { "in":"path", "name":"externalId", "description":"A unique identifier of the leave record as represented in the external system - Human Capital Management", "example":"300000230453798", "required":true, "schema":{ "type":"string" } } ], "tags":[ "Resources/Absences" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UPDATEADDLEAVE_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UPDATEADDLEAVE_request/properties/W1UpdLeave" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UPDATEADDLEAVE_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UPDATEADDLEAVE_response/properties/W1UpdLeave" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UPDATEADDLEAVE_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UPDATEADDLEAVE_error/properties/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/UPDATEADDLEAVE_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/UPDATEADDLEAVE_error/properties/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-resources-leave-{externalId}-put", "x-filename-id":"https-server-port-rest-apis-asset-resources-leave-externalid-put" } }, "https://server:port/rest/apis/asset/purchasing/vendorLocationSynchronization/":{ "post":{ "summary":"Synchronize Vendor Location", "description":"This REST service synchronizes Enterprise Resource Planning (ERP) Suppliers with Work and Asset Management Vendor and Vendor Locations, by creating Work and Asset Management Vendor Location Data Synchronization objects.", "operationId":"syncVendorLocation", "tags":[ "Purchasing/Vendor Location Synchronization" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCVENDORLOCATION_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCVENDORLOCATION_request/properties/W1VndLocSyn" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCVENDORLOCATION_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCVENDORLOCATION_response/properties/W1VndLocSyn" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCVENDORLOCATION_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCVENDORLOCATION_error/properties/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCVENDORLOCATION_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCVENDORLOCATION_error/properties/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-purchasing-vendorLocationSynchronization--post", "x-filename-id":"https-server-port-rest-apis-asset-purchasing-vendorlocationsynchronization-post" } }, "https://server:port/rest/apis/asset/purchasing/invoiceSynchronization/":{ "post":{ "summary":"Synchronize Invoice", "description":"This REST service synchronizes Enterprise Resource Planning (ERP) Invoice and Payments with Work and Asset Management, by creating Work and Asset Management Invoice inbound integration objects.", "operationId":"syncInvoice", "tags":[ "Purchasing/Invoicing" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCINVOICE_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCINVOICE_request/properties/W1InvoiceSyn" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCINVOICE_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCINVOICE_response/properties/W1InvoiceSyn" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCINVOICE_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCINVOICE_error/properties/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCINVOICE_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCINVOICE_error/properties/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-purchasing-invoiceSynchronization--post", "x-filename-id":"https-server-port-rest-apis-asset-purchasing-invoicesynchronization-post" } }, "https://server:port/rest/apis/asset/resources/employeeSynchronization/":{ "post":{ "summary":"Synchronize Employee", "description":"This REST web service synchronizes Enterprise Resource Planning - Human Capital Management Employee records with Work and Asset Management.", "operationId":"syncEmployee", "tags":[ "Resources/Employees" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCEMPLOYEE_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCEMPLOYEE_request/properties/W1CreEmpSync" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCEMPLOYEE_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCEMPLOYEE_response/properties/W1CreEmpSync" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCEMPLOYEE_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCEMPLOYEE_error/properties/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SYNCEMPLOYEE_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SYNCEMPLOYEE_error/properties/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-resources-employeeSynchronization--post", "x-filename-id":"https-server-port-rest-apis-asset-resources-employeesynchronization-post" } }, "https://server:port/rest/apis/asset/financials/createOrUpdateProject/":{ "post":{ "summary":"Create or Update Project", "operationId":"createOrUpdateProj", "tags":[ "Financials/Create or Update Project" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CREATEORUPDATEPROJ_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CREATEORUPDATEPROJ_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CREATEORUPDATEPROJ_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CREATEORUPDATEPROJ_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-financials-createOrUpdateProject--post", "x-filename-id":"https-server-port-rest-apis-asset-financials-createorupdateproject-post" } }, "https://server:port/rest/apis/asset/work/workActivity/scheduleWindow/{activityId}":{ "patch":{ "summary":"Patch Work Activity Schedule Window", "description":"Updates the scheduling window of activities. There is a work window start date/time through a work window end date/time that can be updated from other external systems that manage enterprise project planning.", "operationId":"W1-UpdSchWin", "parameters":[ { "in":"path", "name":"activityId", "description":"System generated primary key up to 14 numeric digit identifier for the work activity record.", "example":"01678656581367", "required":true, "schema":{ "type":"string" } } ], "tags":[ "Work/Work Activity" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1-UPDSCHWIN_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1-UPDSCHWIN_request/properties/W1-UpdSchWin" } } } }, "responses":{ "200":{ "description":"Success response. The request was successfully completed. A 200 status is returned for a successful PATCH method.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1-UPDSCHWIN_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1-UPDSCHWIN_response/properties/W1-UpdSchWin" } } } }, "400":{ "description":"Bad Request. The request could not be processed because it contains missing or invalid information (such as a validation error on an input field, a missing required value, and so on).", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1-UPDSCHWIN_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1-UPDSCHWIN_error/properties/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error. The server encountered an unexpected condition that prevented it from fulfilling the request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1-UPDSCHWIN_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1-UPDSCHWIN_error/properties/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-work-workActivity-scheduleWindow-{activityId}-patch", "x-filename-id":"https-server-port-rest-apis-asset-work-workactivity-schedulewindow-activityid-patch" } }, "https://server:port/rest/apis/asset/work/workActivity/{activityId}":{ "get":{ "summary":"Get Work Activity", "description":"Retrieves activity details for project planning, not including attachments.", "operationId":"W1-PrjActDtl", "parameters":[ { "in":"path", "name":"activityId", "description":"System generated primary key up to 14 numeric digit identifier for the work activity record.", "example":"01678656581367", "required":true, "schema":{ "type":"string" } } ], "tags":[ "Work/Work Activity" ], "responses":{ "200":{ "description":"Success response. The request was successfully completed. A 200 status is returned for a successful GET method.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1-PRJACTDTL_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1-PRJACTDTL_response/properties/W1-PrjActDtl" } } } }, "400":{ "description":"Bad Request. The request could not be processed because it contains missing or invalid information (such as a validation error on an input field, a missing required value, and so on).", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1-PRJACTDTL_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1-PRJACTDTL_error/properties/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error. The server encountered an unexpected condition that prevented it from fulfilling the request.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/W1-PRJACTDTL_error" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/W1-PRJACTDTL_error/properties/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-work-workActivity-{activityId}-get", "x-filename-id":"https-server-port-rest-apis-asset-work-workactivity-activityid-get" } }, "https://server:port/rest/apis/asset/work/communication/":{ "post":{ "summary":"Create Communication", "description":"This operation creates the communication log and links it to the work document provided in the request.", "operationId":"createCommunication", "tags":[ "Work/Communication" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CREATECOMMUNICATION_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CREATECOMMUNICATION_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CREATECOMMUNICATION_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CREATECOMMUNICATION_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-work-communication--post", "x-filename-id":"https-server-port-rest-apis-asset-work-communication-post" } }, "https://server:port/rest/apis/asset/work/serviceCalls/{serviceCallId}/cancelRequest":{ "patch":{ "summary":"Cancel Service Call", "description":"This operation is used to request the cancelation of a service call. It creates a new communication log and a to do entry to process the cancelation request manually.", "operationId":"cancelServiceCall", "parameters":[ { "in":"path", "name":"serviceCallId", "required":true, "schema":{ "type":"string" } } ], "tags":[ "Work/Maintain Service Calls" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CANCELSERVICECALL_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CANCELSERVICECALL_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CANCELSERVICECALL_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CANCELSERVICECALL_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-work-serviceCalls-{serviceCallId}-cancelRequest-patch", "x-filename-id":"https-server-port-rest-apis-asset-work-servicecalls-servicecallid-cancelrequest-patch" } }, "https://server:port/rest/apis/asset/work/serviceCalls/":{ "post":{ "summary":"Create Service Call", "description":"This operation is used to create a new service call based on the information provided in the request. The service call system generated ID can be used to get additional details about the service call and its related work documents and if needed, to request the cancelation of the service call.", "operationId":"createServiceCall", "tags":[ "Work/Service Call Maintenance" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CREATESERVICECALL_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CREATESERVICECALL_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CREATESERVICECALL_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/CREATESERVICECALL_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-work-serviceCalls--post", "x-filename-id":"https-server-port-rest-apis-asset-work-servicecalls-post" } }, "https://server:port/rest/apis/asset/work/serviceCalls/search":{ "post":{ "summary":"Service Call Search", "description":"This operation is used to find service calls matching specific input filters.", "operationId":"searchServiceCall", "parameters":[ { "in":"query", "name":"limit", "required":false, "schema":{ "type":"number" } } ], "tags":[ "Work/Service Call Maintenance" ], "requestBody":{ "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SEARCHSERVICECALL_request" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SEARCHSERVICECALL_request" } } } }, "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SEARCHSERVICECALL_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/SEARCHSERVICECALL_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-work-serviceCalls-search-post", "x-filename-id":"https-server-port-rest-apis-asset-work-servicecalls-search-post" } }, "https://server:port/rest/apis/asset/work/serviceCalls/{entityType}/{entityId}":{ "get":{ "summary":"Get Service Call Entities", "description":"This operation retrieves other work documents, e.g. work request, work design, work order and work activity, that are initiated from the service call. All communication logs related to the work documents are also returned.", "operationId":"getServiceCallEntities", "parameters":[ { "in":"path", "name":"entityId", "required":true, "schema":{ "type":"string" } }, { "in":"path", "name":"entityType", "required":true, "schema":{ "type":"string" } } ], "tags":[ "Work/Service Call Maintenance" ], "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GETSERVICECALLENTITIES_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GETSERVICECALLENTITIES_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-work-serviceCalls-{entityType}-{entityId}-get", "x-filename-id":"https-server-port-rest-apis-asset-work-servicecalls-entitytype-entityid-get" } }, "https://server:port/rest/apis/asset/work/serviceCalls/{serviceCallId}":{ "get":{ "summary":"Get Service Call", "description":"This operation is used to retrieve additional information about the service call. All communication logs for the service call are also returned.", "operationId":"getServiceCall", "parameters":[ { "in":"path", "name":"serviceCallId", "description":"test desc", "example":"test example", "required":true, "schema":{ "type":"string" } } ], "tags":[ "Work/Service Call Maintenance" ], "responses":{ "200":{ "description":"Success response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/GETSERVICECALL_response" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/GETSERVICECALL_response" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/problemDetailDocument" } } } } }, "x-internal-id":"https:--server:port-rest-apis-asset-work-serviceCalls-{serviceCallId}-get", "x-filename-id":"https-server-port-rest-apis-asset-work-servicecalls-servicecallid-get" } } }, "components":{ "securitySchemes":{ "BasicAuth":{ "type":"http", "scheme":"basic" } }, "schemas":{ "problemDetailDocument":{ "type":"object", "properties":{ "problemType":{ "type":"string", "maxLength":60, "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework." }, "title":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "httpStatus":{ "type":"number", "maximum":9999, "minimum":0, "description":"The HTTP Status code for the error." }, "detail":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." }, "problemInstance":{ "type":"string", "maxLength":60, "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction." }, "stackTrace":{ "type":"string", "maxLength":60, "description":"The stack trace shows where the error occurs during the execution of a program." }, "serverMessage":{ "type":"object", "properties":{ "messageCategory":{ "type":"number", "maximum":0, "minimum":0, "description":"Message Category within Oracle Utilities Application Framework." }, "messageNbr":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework." }, "callSequence":{ "type":"string", "maxLength":60, "description":"Delimited sequence of programs called." }, "programName":{ "type":"string", "maxLength":60, "description":"Name of the program that encountered the error." }, "messageText":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "longDescription":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." } } } } }, "CREATEMATERIALISSUE_request":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The Work and Asset Management code that represents the external system.", "example":"ERP" }, "materialIssueLineExternalId":{ "type":"string", "maxLength":14, "description":"A unique identifier of the Material Issue Line record as represented in the external system.", "example":"9BE5876545A" }, "materialRequestHeaderId":{ "type":"string", "maxLength":14, "description":"System-generated ID in the Work and Asset Management system to uniquely identify the Material Request Header.", "example":"59279750490857" }, "materialRequestLineId":{ "type":"string", "maxLength":14, "description":"System-generated ID in the Work and Asset Management system to uniquely identify the Material Request Line.", "example":"99640565085497" }, "stockItemDetailExternalId":{ "type":"string", "maxLength":12, "description":"A unique identifier of the related Stock Item Detail record as represented in the external system.", "example":"D096427592BCE" }, "issuedQuantity":{ "type":"number", "maximum":"99999999.99999", "minimum":0, "description":"The quantity of materials issued from the storeroom.", "example":"10" }, "totalCost":{ "type":"number", "description":"The calculated cost of the issued materials based on Unit Price and Issued Quantity.", "example":"120.95" } }, "xml":{ "name":"W1CreMtlIss" } }, "CREATEMATERIALISSUE_response":{ "type":"object", "properties":{ "materialIssueLineExternalId":{ "type":"string", "maxLength":14, "description":"A unique identifier of the Material Issue Line record as represented in the external system.", "example":"9BE5876545A" }, "materialIssueLineId":{ "type":"string", "maxLength":14, "description":"Material Issue Line" } }, "xml":{ "name":"W1CreMtlIss" } }, "INVENTORYADJUSTMENT_request":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The Work and Asset Management code that represents the external system.", "example":"ERP" }, "externalId":{ "type":"string", "maxLength":60, "description":"A unique identifier of the record as represented in the external system.", "example":"300001230554550" }, "stockItemDetailId":{ "type":"string", "maxLength":12, "description":"System-generated ID in the Work and Asset Management system to uniquely identify the Stock Item Detail.", "example":"815404563965" }, "transactionDate":{ "type":"string", "format":"date", "description":"Transaction Date" }, "averageUnitPrice":{ "type":"number", "maximum":"99999999999.9999", "minimum":0, "description":"Average Unit Price of the Stock Item.", "example":"120.59" }, "inventoryQty":{ "type":"number", "maximum":"99999999.99999", "minimum":"-99999999.99999", "description":"Inventory quantity of the stock transaction.", "example":"10" } }, "xml":{ "name":"W1ProcInvAdj" } }, "INVENTORYADJUSTMENT_response":{ "type":"object", "properties":{ "externalId":{ "type":"string", "maxLength":60, "description":"A unique identifier of the record as represented in the external system.", "example":"300001230554550" }, "stockItemDetailId":{ "type":"string", "maxLength":12, "description":"System-generated ID in the Work and Asset Management system to uniquely identify the Stock Item Detail.", "example":"815404563965" }, "stockTransactionId":{ "type":"string", "maxLength":14, "description":"Stock Transaction ID" } }, "xml":{ "name":"W1ProcInvAdj" } }, "MANAGESTOCKITEMDETAIL_request":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The Work and Asset Management code that represents the external system.", "example":"ERP" }, "externalId":{ "type":"string", "maxLength":60, "description":"A unique identifier of the record as represented in the external system.", "example":"300001230554550" }, "stockItemDetailId":{ "type":"string", "maxLength":12, "description":"System-generated ID in the Work and Asset Management system to uniquely identify the Stock Item Detail.", "example":"815404563965" }, "stockItemExternalId":{ "type":"string", "maxLength":60, "description":"Unique identification of the Stock Item in the external system.", "example":"500000228404042" }, "storeroomExternalId":{ "type":"string", "maxLength":60, "description":"Unique identification of the Storeroom in the external system.", "example":"300000058336894" }, "stockItemDetailClass":{ "type":"string", "enum":[ "W1DP", "W1ER", "W1IL", "W1IN", "W1IT", "W1SD", "W1SL" ], "description":"Stock Item Detail Class\n* `W1DP` - Direct Purchase,\n* `W1ER` - Expensed at Receipt,\n* `W1IL` - Inventory Lot Managed,\n* `W1IN` - Inventory,\n* `W1IT` - Inventory Tracked,\n* `W1SD` - Specific Direct Purchase,\n* `W1SL` - Specific Lot", "example":"W1IN" }, "status":{ "type":"string", "maxLength":12, "description":"The current status of the Stock Item Detail.", "example":"ACTIVE" }, "unitOfPurchase":{ "type":"string", "maxLength":30, "description":"Defines the type of unit used to when purchasing items to replenish inventory to the storeroom.", "example":"BOX" }, "unitOfIssue":{ "type":"string", "maxLength":30, "description":"Defines the type of unit used to issue item from the storeroom.", "example":"EACH" }, "purchaseToIssueRatio":{ "type":"number", "maximum":99999999, "minimum":0, "description":"Number representing the relationship between the Unit of Purchase and the Unit of Issue. This ratio can be used to determine the number of units issued from each unit purchased.", "example":"1" }, "inventory":{ "type":"object", "properties":{ "segment1":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"012" }, "segment2":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"012" }, "segment3":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"012" }, "segment4":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"012" }, "segment5":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"012" }, "segment6":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"012" }, "segment7":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"012" }, "segment8":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"012" }, "segment9":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"012" }, "segment10":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"012" } } } }, "xml":{ "name":"W1ProcSID" } }, "MANAGESTOCKITEMDETAIL_response":{ "type":"object", "properties":{ "externalId":{ "type":"string", "maxLength":60, "description":"A unique identifier of the record as represented in the external system.", "example":"300001230554550" }, "stockItemDetailId":{ "type":"string", "maxLength":12, "description":"System-generated ID in the Work and Asset Management system to uniquely identify the Stock Item Detail.", "example":"815404563965" } }, "xml":{ "name":"W1ProcSID" } }, "MANAGESTOREROOM_request":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The Work and Asset Management code that represents the external system.", "example":"ERP" }, "externalId":{ "type":"string", "maxLength":60, "description":"A unique identifier of the record as represented in the external system.", "example":"300000058336894" }, "storeroomId":{ "type":"string", "maxLength":12, "description":"System-generated ID in the Work and Asset Management system to uniquely identify the storeroom.", "example":"006972495096" }, "category":{ "type":"string", "enum":[ "W1ST", "W1TR", "W1UN" ], "description":"Storeroom Category\n* `W1ST` - Standard,\n* `W1TR` - Truck,\n* `W1UN` - Unmanned", "example":"W1ST" }, "description":{ "type":"string", "maxLength":100, "description":"Brief description up to 100 characters for the storeroom.", "example":"Main Storeroom A" }, "status":{ "type":"string", "enum":[ "W1AC", "W1IA" ], "description":"Location Disposition:\n* `W1AC` - Active,\n* `W1IA` - Inactive" }, "location":{ "type":"object", "properties":{ "address1":{ "type":"string", "maxLength":254, "description":"The first line for the address, associated with the storeroom.", "example":"475 Sansome Street" }, "address2":{ "type":"string", "maxLength":254, "description":"The second line for the address, associated with the storeroom.", "example":"#15" }, "address3":{ "type":"string", "maxLength":254, "description":"The third line for the address, associated with the storeroom.", "example":"Building A" }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line for the address, associated with the storeroom.", "example":"Suite 101" }, "crossStreet":{ "type":"string", "maxLength":64, "description":"The Cross Street the PO address.", "example":"First Street" }, "houseType":{ "type":"string", "enum":[ ], "description":"House Type:\n" }, "number1":{ "type":"string", "maxLength":6, "description":"Storeroom street number 1.", "example":"1400" }, "number2":{ "type":"string", "maxLength":4, "description":"Storeroom street number 2.", "example":"Building 2" }, "geographicCode":{ "type":"string", "maxLength":11, "description":"The Geographic Code for the storeroom address.", "example":"215" }, "inCityLimit":{ "type":"boolean", "description":"Indicates if the storeroom address is within the city boundary.", "example":"Yes" }, "city":{ "type":"string", "maxLength":90, "description":"The City for the storeroom address.", "example":"San Francisco" }, "suburb":{ "type":"string", "maxLength":64, "description":"The Suburb for the storeroom address.", "example":"Park Ridge" }, "county":{ "type":"string", "maxLength":90, "description":"County of the storeroom address.", "example":"Alameda" }, "state":{ "type":"string", "maxLength":6, "description":"State of the storeroom address.", "example":"CA" }, "postal":{ "type":"string", "maxLength":12, "description":"The Postal Code for the storeroom address.", "example":"94111" }, "country":{ "type":"string", "maxLength":3, "description":"The Country Code for the storeroom address.", "example":"USA" }, "locationClass":{ "type":"string", "enum":[ "W1NA" ], "description":"Location Class\n* `W1NA` - Not Applicable", "example":"W1NA" } } }, "timeZone":{ "type":"string", "maxLength":10, "description":"Time Zone of the storeroom address.", "example":"USPACIFIC" }, "inventory":{ "type":"object", "properties":{ "segment1":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment2":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment3":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment4":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment5":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment6":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment7":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment8":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment9":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment10":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" } } }, "inventoryAdjustment":{ "type":"object", "properties":{ "segment1":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment2":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment3":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment4":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment5":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment6":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment7":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment8":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment9":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment10":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" } } }, "markup":{ "type":"object", "properties":{ "segment1":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment2":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment3":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment4":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment5":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment6":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment7":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment8":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment9":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment10":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" } } }, "stockTransferClearing":{ "type":"object", "properties":{ "segment1":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment2":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment3":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment4":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment5":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment6":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment7":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment8":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment9":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment10":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" } } }, "taxAccountSegment":{ "type":"object", "properties":{ "segment1":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment2":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment3":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment4":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment5":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment6":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment7":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment8":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment9":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment10":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" } } }, "invoiceWriteOff":{ "type":"object", "properties":{ "segment1":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment2":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment3":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment4":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment5":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment6":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment7":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment8":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment9":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" }, "segment10":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Account Segment.", "example":"011" } } } }, "xml":{ "name":"W1ProcStrm" } }, "MANAGESTOREROOM_response":{ "type":"object", "properties":{ "externalId":{ "type":"string", "maxLength":60, "description":"A unique identifier of the record as represented in the external system.", "example":"300000058336894" }, "storeroomId":{ "type":"string", "maxLength":12, "description":"System-generated ID in the Work and Asset Management system to uniquely identify the storeroom.", "example":"006972495096" } }, "xml":{ "name":"W1ProcStrm" } }, "EXTERNALUPDATEADDCRAFT_error":{ "type":"object", "properties":{ "problemDetailDocument":{ "type":"object", "properties":{ "problemType":{ "type":"string", "maxLength":60, "description":"URL of the format 'A/message/X/Y' where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework." }, "title":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "httpStatus":{ "type":"number", "maximum":9999, "minimum":0, "description":"The HTTP Status code for the error." }, "detail":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." }, "problemInstance":{ "type":"string", "maxLength":60, "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction." }, "stackTrace":{ "type":"string", "maxLength":60, "description":"The stack trace shows where the error occurs during the execution of a program." }, "serverMessage":{ "type":"object", "properties":{ "messageCategory":{ "type":"number", "maximum":0, "minimum":0, "description":"Message Category within Oracle Utilities Application Framework." }, "messageNbr":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework." }, "callSequence":{ "type":"string", "maxLength":60, "description":"Delimited sequence of programs called." }, "programName":{ "type":"string", "maxLength":60, "description":"Name of the program that encountered the error." }, "messageText":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "longDescription":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." } } } } } } }, "EXTERNALUPDATEADDCRAFT_request":{ "type":"object", "properties":{ "W1UpdAdCraft":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The Work and Asset Management code that represents the external system.", "example":"HCM" }, "externalId":{ "type":"string", "maxLength":60, "description":"A unique identifier to the craft as represented in the external system - Human Capital Management", "example":"300000047336894" }, "craftCode":{ "type":"string", "maxLength":60, "description":"Unique code for the craft", "example":"IDC_ELECTRICIAN" }, "status":{ "type":"string", "maxLength":12, "description":"Craft Status", "example":"Active" }, "description":{ "type":"string", "maxLength":100, "description":"Short description for a type of craft resource. Typically a special skill or contract worker" }, "longDescription":{ "type":"string", "maxLength":4000, "description":"Long description for a type of craft resource. Typically a special skill or contract worker" }, "resourceSource":{ "type":"string", "enum":[ "W1IN", "W1PR" ], "description":"Provides a reference to where the craft resource can be located or obtained. Internal or Purchased.\n* `W1IN` - Internal,\n* `W1PR` - Purchased", "example":"Internal, Purchased" }, "defaultValueToActivity":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether or not the item information should be defaulted onto activities when resource requirements reference the craft. If this is set to No, then the stock item can only be added to stock item details as a direct purchase item.\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"Yes" }, "acceptOnReceipt":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Applies to contracted resources to indicate whether or not the system can automatically accept the work, or service, without someone reviewing or accepting it manually.\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"Yes" }, "schedulePriority":{ "type":"number", "maximum":999, "minimum":0, "description":"A numerical value which is used to denote the order in which the principal craft duration is determined when labor requirement assignments are made to a secondary craft. 1 is a high priority and 999 is a low priority. The default is 100. If two crafts have the same secondary craft, they should be set with different priorities.", "example":"100" }, "unitPricesList":{ "type":"array", "items":{ "type":"object", "properties":{ "effectiveDate":{ "type":"string", "format":"date", "description":"Date when the Unit Price goes into effect", "example":"10-14-2020" }, "unitPrice":{ "type":"number", "maximum":"100000000000", "minimum":"-100000000000", "description":"Unit Price for the Craft", "example":"100" } } } }, "regularExpenseCode":{ "type":"string", "maxLength":30, "description":"Regular expense code for the craft", "example":"110 - Labor - Regular" }, "premiumExpenseCode":{ "type":"string", "maxLength":30, "description":"Premium expense code for the craft", "example":"120 - Labor - Premium" } } }, "output":{ "type":"object", "properties":{ "craftId":{ "type":"string", "maxLength":12, "description":"Unique ID sent by Work and Asset Management System on each outbound message" } } } } } } }, "EXTERNALUPDATEADDCRAFT_response":{ "type":"object", "properties":{ "W1UpdAdCraft":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The Work and Asset Management code that represents the external system.", "example":"HCM" }, "externalId":{ "type":"string", "maxLength":60, "description":"A unique identifier to the craft as represented in the external system - Human Capital Management", "example":"300000047336894" }, "craftCode":{ "type":"string", "maxLength":60, "description":"Unique code for the craft", "example":"IDC_ELECTRICIAN" }, "status":{ "type":"string", "maxLength":12, "description":"Craft Status", "example":"Active" }, "description":{ "type":"string", "maxLength":100, "description":"Short description for a type of craft resource. Typically a special skill or contract worker" }, "longDescription":{ "type":"string", "maxLength":4000, "description":"Long description for a type of craft resource. Typically a special skill or contract worker" }, "resourceSource":{ "type":"string", "enum":[ "W1IN", "W1PR" ], "description":"Provides a reference to where the craft resource can be located or obtained. Internal or Purchased.\n* `W1IN` - Internal,\n* `W1PR` - Purchased", "example":"Internal, Purchased" }, "defaultValueToActivity":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether or not the item information should be defaulted onto activities when resource requirements reference the craft. If this is set to No, then the stock item can only be added to stock item details as a direct purchase item.\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"Yes" }, "acceptOnReceipt":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Applies to contracted resources to indicate whether or not the system can automatically accept the work, or service, without someone reviewing or accepting it manually.\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"Yes" }, "schedulePriority":{ "type":"number", "maximum":999, "minimum":0, "description":"A numerical value which is used to denote the order in which the principal craft duration is determined when labor requirement assignments are made to a secondary craft. 1 is a high priority and 999 is a low priority. The default is 100. If two crafts have the same secondary craft, they should be set with different priorities.", "example":"100" }, "unitPricesList":{ "type":"array", "items":{ "type":"object", "properties":{ "effectiveDate":{ "type":"string", "format":"date", "description":"Date when the Unit Price goes into effect", "example":"10-14-2020" }, "unitPrice":{ "type":"number", "maximum":"100000000000", "minimum":"-100000000000", "description":"Unit Price for the Craft", "example":"100" } } } }, "regularExpenseCode":{ "type":"string", "maxLength":30, "description":"Regular expense code for the craft", "example":"110 - Labor - Regular" }, "premiumExpenseCode":{ "type":"string", "maxLength":30, "description":"Premium expense code for the craft", "example":"120 - Labor - Premium" } } }, "output":{ "type":"object", "properties":{ "craftId":{ "type":"string", "maxLength":12, "description":"Unique ID sent by Work and Asset Management System on each outbound message" } } } } } } }, "SYNCBLANKETCONTRACT_error":{ "type":"object", "properties":{ "problemDetailDocument":{ "type":"object", "properties":{ "problemType":{ "type":"string", "maxLength":60, "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework." }, "title":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "httpStatus":{ "type":"number", "maximum":9999, "minimum":0, "description":"The HTTP Status code for the error." }, "detail":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." }, "problemInstance":{ "type":"string", "maxLength":60, "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction." }, "stackTrace":{ "type":"string", "maxLength":60, "description":"The stack trace shows where the error occurs during the execution of a program." }, "serverMessage":{ "type":"object", "properties":{ "messageCategory":{ "type":"number", "maximum":0, "minimum":0, "description":"Message Category within Oracle Utilities Application Framework." }, "messageNbr":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework." }, "callSequence":{ "type":"string", "maxLength":60, "description":"Delimited sequence of programs called." }, "programName":{ "type":"string", "maxLength":60, "description":"Name of the program that encountered the error." }, "messageText":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "longDescription":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." } } } } } } }, "SYNCBLANKETCONTRACT_request":{ "type":"object", "properties":{ "W1BlnktSyn":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.", "example":"ERP" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.", "example":"300000230554500" }, "blanketContract":{ "type":"object", "properties":{ "header":{ "type":"object", "properties":{ "blanketContractHeaderExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "blanketContractNumber":{ "type":"string", "maxLength":14, "description":"Unique number for the Blanket Contract.", "example":"52315" }, "revisionNumber":{ "type":"number", "maximum":999, "minimum":-999, "description":"The revision number of the Blanket Contract.", "example":"1" }, "status":{ "type":"string", "maxLength":12, "description":"Current Status of the Blanket Contract. BLanket Contract can support the following status states: Created, Awaiting Activation, Active, Closed, and Suspended, respectively. As long as the blanket contract is in an Active status, it can be referenced by new purchasing documents to order materials or services. Contracts can be set to a Suspended status so that they are temporarily unavailable for new purchases. This might be used while re-negotiating terms with a vendor, if you are researching new vendors for a particular item or service, or for other business requirements.", "example":"ACTIVE" }, "description":{ "type":"string", "maxLength":100, "description":"Brief description of the Blanket Contract.", "example":"Blanket Contract Rev 3" }, "blanketCategory":{ "type":"string", "enum":[ "ZZBP", "ZZCP" ], "description":"The category field provides information indicating the type of contract such as whether it is for goods or services.\n* `ZZBP` - Blanket Purchase Agreement (BPA),\n* `ZZCP` - Contract Purchase Agreement (CPA)", "example":"BPA" }, "creationDateTime":{ "type":"string", "format":"date-time", "description":"Date and Time when the Blanket Contract was initiated.", "example":"2021-10-13T13:05:51.000+00:00" }, "limitAmount":{ "type":"number", "maximum":"999999999999.999", "minimum":"-999999999999.999", "description":"The dollar value limit for the contract.", "example":"10000" }, "initiationDate":{ "type":"string", "format":"date", "description":"The initiation date is the first date the blanket contract can be used.", "example":"2021-10-13" }, "expirationDate":{ "type":"string", "format":"date", "description":"The expiration date indicates the date by which the contract must be renegotiated.", "example":"2021-12-31" }, "vendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"External ID" }, "currency":{ "type":"string", "maxLength":3, "description":"Currency Code.", "example":"USD" }, "fob":{ "type":"string", "maxLength":30, "description":"Free on board code. This field is controlled by the Free on Board portal.", "example":"WD-DestFreightPrepaid" }, "paymentTerms":{ "type":"string", "maxLength":30, "description":"Blanket Contract Payment Terms.", "example":"CM-Pay30Days" } } }, "lines":{ "type":"object", "properties":{ "_data":{ "type":"array", "items":{ "type":"object", "properties":{ "blanketContractLineExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "creationDateTime":{ "type":"string", "format":"date-time", "description":"Date and Time when the Blanket Contract was initiated.", "example":"2021-10-13T13:05:51.000+00:00" }, "description":{ "type":"string", "maxLength":100, "description":"Brief description of the Blanket Contract.", "example":"Blanket Contract Rev 3" }, "resourceTypeExternalId":{ "type":"string", "maxLength":60, "description":"External ID" }, "lineNumber":{ "type":"number", "maximum":999, "minimum":0, "description":"Blanket Contract Line Number", "example":"1" }, "allowOnPo":{ "type":"string", "enum":[ "W1AL", "W1NA" ], "description":"Indicates whether or not the item can be included on the purchase order or requisition when it is created from the blanket contract. The item does not appear on the item pick list if it is not allowed. This indicator is used in higher revisions where certain items may cease to be covered by the blanket contract.\n* `W1AL` - Yes,\n* `W1NA` - No", "example":"W1AL" }, "requisitionInfo":{ "type":"object", "properties":{ "unitPrice":{ "type":"number", "maximum":"100000000000", "minimum":"-100000000000", "description":"Blanket Contract Unit Price.", "example":"$100" }, "unitOfPurchase":{ "type":"string", "maxLength":30, "description":"Blanket Contract Unit of Purchase.", "example":"WD-Each" }, "purchaseToIssueRatio":{ "type":"number", "maximum":99999999, "minimum":0, "description":"PI Ratio", "example":"1" } } } } } } } } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)" } } } } } } }, "SYNCBLANKETCONTRACT_response":{ "type":"object", "properties":{ "W1BlnktSyn":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.", "example":"ERP" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.", "example":"300000230554500" }, "blanketContract":{ "type":"object", "properties":{ "header":{ "type":"object", "properties":{ "blanketContractHeaderExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "blanketContractNumber":{ "type":"string", "maxLength":14, "description":"Unique number for the Blanket Contract.", "example":"52315" }, "revisionNumber":{ "type":"number", "maximum":999, "minimum":-999, "description":"The revision number of the Blanket Contract.", "example":"1" }, "status":{ "type":"string", "maxLength":12, "description":"Current Status of the Blanket Contract. BLanket Contract can support the following status states: Created, Awaiting Activation, Active, Closed, and Suspended, respectively. As long as the blanket contract is in an Active status, it can be referenced by new purchasing documents to order materials or services. Contracts can be set to a Suspended status so that they are temporarily unavailable for new purchases. This might be used while re-negotiating terms with a vendor, if you are researching new vendors for a particular item or service, or for other business requirements.", "example":"ACTIVE" }, "description":{ "type":"string", "maxLength":100, "description":"Brief description of the Blanket Contract.", "example":"Blanket Contract Rev 3" }, "blanketCategory":{ "type":"string", "enum":[ "ZZBP", "ZZCP" ], "description":"The category field provides information indicating the type of contract such as whether it is for goods or services.\n* `ZZBP` - Blanket Purchase Agreement (BPA),\n* `ZZCP` - Contract Purchase Agreement (CPA)", "example":"BPA" }, "creationDateTime":{ "type":"string", "format":"date-time", "description":"Date and Time when the Blanket Contract was initiated.", "example":"2021-10-13T13:05:51.000+00:00" }, "limitAmount":{ "type":"number", "maximum":"999999999999.999", "minimum":"-999999999999.999", "description":"The dollar value limit for the contract.", "example":"10000" }, "initiationDate":{ "type":"string", "format":"date", "description":"The initiation date is the first date the blanket contract can be used.", "example":"2021-10-13" }, "expirationDate":{ "type":"string", "format":"date", "description":"The expiration date indicates the date by which the contract must be renegotiated.", "example":"2021-12-31" }, "vendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"External ID" }, "currency":{ "type":"string", "maxLength":3, "description":"Currency Code.", "example":"USD" }, "fob":{ "type":"string", "maxLength":30, "description":"Free on board code. This field is controlled by the Free on Board portal.", "example":"WD-DestFreightPrepaid" }, "paymentTerms":{ "type":"string", "maxLength":30, "description":"Blanket Contract Payment Terms.", "example":"CM-Pay30Days" } } }, "lines":{ "type":"object", "properties":{ "_data":{ "type":"array", "items":{ "type":"object", "properties":{ "blanketContractLineExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "creationDateTime":{ "type":"string", "format":"date-time", "description":"Date and Time when the Blanket Contract was initiated.", "example":"2021-10-13T13:05:51.000+00:00" }, "description":{ "type":"string", "maxLength":100, "description":"Brief description of the Blanket Contract.", "example":"Blanket Contract Rev 3" }, "resourceTypeExternalId":{ "type":"string", "maxLength":60, "description":"External ID" }, "lineNumber":{ "type":"number", "maximum":999, "minimum":0, "description":"Blanket Contract Line Number", "example":"1" }, "allowOnPo":{ "type":"string", "enum":[ "W1AL", "W1NA" ], "description":"Indicates whether or not the item can be included on the purchase order or requisition when it is created from the blanket contract. The item does not appear on the item pick list if it is not allowed. This indicator is used in higher revisions where certain items may cease to be covered by the blanket contract.\n* `W1AL` - Yes,\n* `W1NA` - No", "example":"W1AL" }, "requisitionInfo":{ "type":"object", "properties":{ "unitPrice":{ "type":"number", "maximum":"100000000000", "minimum":"-100000000000", "description":"Blanket Contract Unit Price.", "example":"$100" }, "unitOfPurchase":{ "type":"string", "maxLength":30, "description":"Blanket Contract Unit of Purchase.", "example":"WD-Each" }, "purchaseToIssueRatio":{ "type":"number", "maximum":99999999, "minimum":0, "description":"PI Ratio", "example":"1" } } } } } } } } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)" } } } } } } }, "W1ChrtActSyn_error":{ "type":"object", "properties":{ "problemDetailDocument":{ "type":"object", "properties":{ "problemType":{ "type":"string", "maxLength":60, "description":"URL of the format 'A/message/X/Y' where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework." }, "title":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "httpStatus":{ "type":"number", "maximum":9999, "minimum":0, "description":"The HTTP Status code for the error." }, "detail":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." }, "problemInstance":{ "type":"string", "maxLength":60, "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction." }, "stackTrace":{ "type":"string", "maxLength":60, "description":"The stack trace shows where the error occurs during the execution of a program." }, "serverMessage":{ "type":"object", "properties":{ "messageCategory":{ "type":"number", "maximum":0, "minimum":0, "description":"Message Category within Oracle Utilities Application Framework." }, "messageNbr":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework." }, "callSequence":{ "type":"string", "maxLength":60, "description":"Delimited sequence of programs called." }, "programName":{ "type":"string", "maxLength":60, "description":"Name of the program that encountered the error." }, "messageText":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "longDescription":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." } } } } } } }, "W1ChrtActSyn_response":{ "type":"object", "properties":{ "W1ChrtActSyn":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.", "example":"ERP" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.", "example":"403094" }, "initialLoad":{ "type":"string", "maxLength":4, "description":"On initial load, chart of accounts that are in an active status are synced from Oracle Enterprise Resource Planning Financials. For incremental sync actions, active and inactive chart of accounts records are synced from Oracle Enterprise Resource Planning Financials.", "example":"F1IL" }, "chartOfAccountsInfo":{ "type":"object", "properties":{ "status":{ "type":"string", "maxLength":12, "description":"Status of the Cost Center based on business object lifecycle.", "example":"ACTIVE" }, "description":{ "type":"string", "maxLength":100, "description":"Description for the cost center, which provides additional context.", "example":"410000 - Credit Funds" }, "segment1":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning segment 1 represents Company. Enterprise Resource Planning segments are mapped to the EBO (Enterprise Business Object) chart of accounts GL (General Ledger) elements list and passed to the Work and Asset Management segment elements.", "example":"101" }, "segment1Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning segment 1 description to provide additional details on the company information.", "example":"101-ABC" }, "segment2":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning segment 2 represents LOB (Line of Business).", "example":"00" }, "segment2Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning segment 2 description to provide additional details on the line of business information.", "example":"00-Equipment" }, "segment3":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning segment 3 represents Expense Code", "example":"001" }, "segment3Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning segment 3 description to provide additional details on the expense code information.", "example":"001-Additional Overhead" }, "segment4":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning segment 4 represents Cost Center", "example":"200" }, "segment4Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning segment 4 description to provide additional details on the cost center information.", "example":"200-Inventory" }, "segment5":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning segment 5 represents Product", "example":"00001" }, "segment5Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning segment 5 description to provide additional details on the product information.", "example":"00001-Pump" }, "segment6":{ "type":"string", "maxLength":254, "description":"ERP Segment 6 represents InterCompany", "example":"102" }, "segment6Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning Segment 6 description to provide additional details on the intercompany information.", "example":"102-Maintenance" }, "segment7":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Segment 7", "example":"" }, "segment7Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning Segment 7 description.", "example":"" }, "segment8":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Segment 8", "example":"" }, "segment8Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning Segment 8 description.", "example":"" }, "segment9":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Segment 9", "example":"" }, "segment9Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning Segment 9 description.", "example":"" }, "segment10":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Segment 10", "example":"" }, "segment10Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning Segment 10 description.", "example":"" } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)" } } } } } } }, "W1ChrtActSyn_request":{ "type":"object", "properties":{ "W1ChrtActSyn":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.", "example":"ERP" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.", "example":"403094" }, "initialLoad":{ "type":"string", "maxLength":4, "description":"On initial load, chart of accounts that are in an active status are synced from Oracle Enterprise Resource Planning Financials. For incremental sync actions, active and inactive chart of accounts records are synced from Oracle Enterprise Resource Planning Financials.", "example":"F1IL" }, "chartOfAccountsInfo":{ "type":"object", "properties":{ "status":{ "type":"string", "maxLength":12, "description":"Status of the Cost Center based on business object lifecycle.", "example":"ACTIVE" }, "description":{ "type":"string", "maxLength":100, "description":"Description for the cost center, which provides additional context.", "example":"410000 - Credit Funds" }, "segment1":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning segment 1 represents Company. Enterprise Resource Planning segments are mapped to the EBO (Enterprise Business Object) chart of accounts GL (General Ledger) elements list and passed to the Work and Asset Management segment elements.", "example":"101" }, "segment1Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning segment 1 description to provide additional details on the company information.", "example":"101-ABC" }, "segment2":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning segment 2 represents LOB (Line of Business).", "example":"00" }, "segment2Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning segment 2 description to provide additional details on the line of business information.", "example":"00-Equipment" }, "segment3":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning segment 3 represents Expense Code", "example":"001" }, "segment3Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning segment 3 description to provide additional details on the expense code information.", "example":"001-Additional Overhead" }, "segment4":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning segment 4 represents Cost Center", "example":"200" }, "segment4Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning segment 4 description to provide additional details on the cost center information.", "example":"200-Inventory" }, "segment5":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning segment 5 represents Product", "example":"00001" }, "segment5Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning segment 5 description to provide additional details on the product information.", "example":"00001-Pump" }, "segment6":{ "type":"string", "maxLength":254, "description":"ERP Segment 6 represents InterCompany", "example":"102" }, "segment6Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning Segment 6 description to provide additional details on the intercompany information.", "example":"102-Maintenance" }, "segment7":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Segment 7", "example":"" }, "segment7Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning Segment 7 description.", "example":"" }, "segment8":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Segment 8", "example":"" }, "segment8Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning Segment 8 description.", "example":"" }, "segment9":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Segment 9", "example":"" }, "segment9Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning Segment 9 description.", "example":"" }, "segment10":{ "type":"string", "maxLength":254, "description":"Enterprise Resource Planning Segment 10", "example":"" }, "segment10Description":{ "type":"string", "maxLength":100, "description":"Enterprise Resource Planning Segment 10 description.", "example":"" } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)" } } } } } } }, "SYNCPURCHASEORDER_response":{ "type":"object", "properties":{ "W1PurOrdSync":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.", "example":"ERP" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.", "example":"300000230453798" }, "purchaseOrder":{ "type":"object", "properties":{ "header":{ "type":"object", "properties":{ "purchaseOrderHeaderExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "status":{ "type":"string", "maxLength":12, "description":"Status of the purchase order based on business object lifecycle.", "example":"ISSUED" }, "purchaseOrderNumber":{ "type":"string", "maxLength":14, "description":"Enterprise Resource Planning system-generated Purchase Order number.", "example":"US164235" }, "revisionNumber":{ "type":"number", "maximum":999, "minimum":-999, "description":"Identification number for revisions to a purchase order.", "example":"0" }, "description":{ "type":"string", "maxLength":100, "description":"Descriptive information about the revision.", "example":"Meter For Central Storeroom" }, "creationDateTime":{ "type":"string", "format":"date-time", "description":"The creation date & time of the purchase order. If left blank, it's defaulted to system date & time when it's created in Work and Asset Management.", "example":"2021-01-20T21:23:45.0Z" }, "buyerEmployeeExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "issueDate":{ "type":"string", "format":"date", "description":"The approval date or the issue date for the purchase order. Integration passes the current date.", "example":"2021-09-15" }, "requiredDate":{ "type":"string", "format":"date", "description":"The date a purchase order is required by the requestor.", "example":"2021-09-30" }, "shipToLocation":{ "type":"string", "maxLength":12, "description":"Storeroom location where the goods are shipped.", "example":"452478085231" }, "deliverToLocation":{ "type":"string", "maxLength":12, "description":"Storeroom location where the goods are delivered.", "example":"452478085232" }, "vendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"External ID" }, "location":{ "type":"object", "properties":{ "address1":{ "type":"string", "maxLength":254, "description":"The first line for the address, associated with the Purchase Order.", "example":"300 New Jersey Avenue" }, "address2":{ "type":"string", "maxLength":254, "description":"The second line for the address, associated with the Purchase Order.", "example":"Suite 1000" }, "address3":{ "type":"string", "maxLength":254, "description":"The third line for the address, associated with the Purchase Order." }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line for the address, associated with the Purchase Order." }, "crossStreet":{ "type":"string", "maxLength":64, "description":"The Cross Street the PO address" }, "houseType":{ "type":"string", "enum":[ ], "description":"The House Type for the PO address\n" }, "number1":{ "type":"string", "maxLength":6, "description":"Address number 1 for the PO address" }, "number2":{ "type":"string", "maxLength":4, "description":"Address number 2 for the PO address" }, "geographicCode":{ "type":"string", "maxLength":11, "description":"The Geographic Code for the PO address" }, "inCityLimit":{ "type":"boolean", "description":"Indicates whether or not this address is within the taxing boundary of the jurisdiction that's provided in the address." }, "city":{ "type":"string", "maxLength":90, "description":"The City for the PO address", "example":"Washington" }, "suburb":{ "type":"string", "maxLength":64, "description":"The Suburb for the PO address" }, "county":{ "type":"string", "maxLength":90, "description":"The County for the PO address", "example":"US" }, "state":{ "type":"string", "maxLength":6, "description":"The Postal Code for the PO address", "example":"District of Columbia" }, "postal":{ "type":"string", "maxLength":12, "description":"The Postal Code for the PO address", "example":"20001" }, "country":{ "type":"string", "maxLength":3, "description":"The Country Code for the PO address" } } }, "currency":{ "type":"string", "maxLength":3, "description":"Currency Code", "example":"United States Dollars" }, "exchangeRate":{ "type":"number", "maximum":"100000000000", "minimum":0, "description":"The rate to convert the currency code values to the default currency.", "example":"1.5" }, "freeOnBoard":{ "type":"string", "maxLength":30, "description":"Determines the costs involved in the delivery of goods." }, "paymentTerms":{ "type":"string", "maxLength":30, "description":"Payment terms between payee and vendor.", "example":"CM-Pay30Days" }, "purchaseDocumentType":{ "type":"string", "enum":[ "W1GP", "W1SR" ], "description":"Indicates where the purchase order is being generated from.\n* `W1GP` - General Purchase,\n* `W1SR` - Store Replenishment", "example":"W1GP" } } }, "lines":{ "type":"object", "properties":{ "_data":{ "type":"array", "items":{ "type":"object", "properties":{ "purchaseOrderLineExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "status":{ "type":"string", "maxLength":12, "description":"Status of the purchase order based on business object lifecycle.", "example":"ISSUED" }, "description":{ "type":"string", "maxLength":100, "description":"Descriptive information about the revision.", "example":"Meter For Central Storeroom" }, "lineNumber":{ "type":"number", "maximum":999, "minimum":0, "description":"The number referencing each Purchase Order Line. These should be unique between lines.", "example":"1" }, "purchaseRequisitionLineId":{ "type":"string", "maxLength":14, "description":"Work and Asset Management Purchase Requisition Line ID sent out during the Purchase Requisition Sync.", "example":"97680207221035" }, "blanketContractLineExternalId":{ "type":"string", "maxLength":60, "description":"External ID" }, "blanketContractNumber":{ "type":"string", "maxLength":14, "description":"Blanket Contract Number" }, "blanketContractLineNumber":{ "type":"number", "maximum":999, "minimum":0, "description":"The number referencing each Purchase Order Line. These should be unique between lines.", "example":"1" }, "itemType":{ "type":"string", "enum":[ "W1MC", "W1MT", "W1SV" ], "description":"Item type\n* `W1MC` - Miscellaneous,\n* `W1MT` - Materials,\n* `W1SV` - Services", "example":"W1MT" }, "quantity":{ "type":"number", "maximum":"99999999.99999", "minimum":0, "description":"Purchase Order quantity", "example":"20" }, "unitPrice":{ "type":"number", "maximum":"100000000000", "minimum":"-100000000000", "description":"Purchase Order Unit Price", "example":"40" }, "unitOfPurchase":{ "type":"string", "maxLength":30, "description":"Purchase Order unit Of Purchase", "example":"WD-EACH" }, "purchaseToIssueRatio":{ "type":"number", "maximum":99999999, "minimum":0, "description":"Purchase to Issue Ratio" }, "requiredDate":{ "type":"string", "format":"date", "description":"The date a purchase order is required by the requestor.", "example":"2021-09-30" }, "promiseDate":{ "type":"string", "format":"date", "description":"Purchase Order Promise Date", "example":"2021-09-28" }, "vendorPartNumber":{ "type":"string", "maxLength":60, "description":"Purchase Order vendorPartNumber", "example":"ASMON1" }, "lineAmount":{ "type":"number", "description":"Purchase Order line amount", "example":"800" } } } } } } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)" } } } } } } }, "SYNCPURCHASEORDER_error":{ "type":"object", "properties":{ "problemDetailDocument":{ "type":"object", "properties":{ "problemType":{ "type":"string", "maxLength":60, "description":"URL of the format 'A/message/X/Y' where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework." }, "title":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "httpStatus":{ "type":"number", "maximum":9999, "minimum":0, "description":"The HTTP Status code for the error." }, "detail":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." }, "problemInstance":{ "type":"string", "maxLength":60, "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction." }, "stackTrace":{ "type":"string", "maxLength":60, "description":"The stack trace shows where the error occurs during the execution of a program." }, "serverMessage":{ "type":"object", "properties":{ "messageCategory":{ "type":"number", "maximum":0, "minimum":0, "description":"Message Category within Oracle Utilities Application Framework." }, "messageNbr":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework." }, "callSequence":{ "type":"string", "maxLength":60, "description":"Delimited sequence of programs called." }, "programName":{ "type":"string", "maxLength":60, "description":"Name of the program that encountered the error." }, "messageText":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "longDescription":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." } } } } } } }, "SYNCPURCHASEORDER_request":{ "type":"object", "properties":{ "W1PurOrdSync":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.", "example":"ERP" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.", "example":"300000230453798" }, "purchaseOrder":{ "type":"object", "properties":{ "header":{ "type":"object", "properties":{ "purchaseOrderHeaderExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "status":{ "type":"string", "maxLength":12, "description":"Status of the purchase order based on business object lifecycle.", "example":"ISSUED" }, "purchaseOrderNumber":{ "type":"string", "maxLength":14, "description":"Enterprise Resource Planning system-generated Purchase Order number.", "example":"US164235" }, "revisionNumber":{ "type":"number", "maximum":999, "minimum":-999, "description":"Identification number for revisions to a purchase order.", "example":"0" }, "description":{ "type":"string", "maxLength":100, "description":"Descriptive information about the revision.", "example":"Meter For Central Storeroom" }, "creationDateTime":{ "type":"string", "format":"date-time", "description":"The creation date & time of the purchase order. If left blank, it's defaulted to system date & time when it's created in Work and Asset Management.", "example":"2021-01-20T21:23:45.0Z" }, "buyerEmployeeExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "issueDate":{ "type":"string", "format":"date", "description":"The approval date or the issue date for the purchase order. Integration passes the current date.", "example":"2021-09-15" }, "requiredDate":{ "type":"string", "format":"date", "description":"The date a purchase order is required by the requestor.", "example":"2021-09-30" }, "shipToLocation":{ "type":"string", "maxLength":12, "description":"Storeroom location where the goods are shipped.", "example":"452478085231" }, "deliverToLocation":{ "type":"string", "maxLength":12, "description":"Storeroom location where the goods are delivered.", "example":"452478085232" }, "vendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"External ID" }, "location":{ "type":"object", "properties":{ "address1":{ "type":"string", "maxLength":254, "description":"The first line for the address, associated with the Purchase Order.", "example":"300 New Jersey Avenue" }, "address2":{ "type":"string", "maxLength":254, "description":"The second line for the address, associated with the Purchase Order.", "example":"Suite 1000" }, "address3":{ "type":"string", "maxLength":254, "description":"The third line for the address, associated with the Purchase Order." }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line for the address, associated with the Purchase Order." }, "crossStreet":{ "type":"string", "maxLength":64, "description":"The Cross Street the PO address" }, "houseType":{ "type":"string", "enum":[ ], "description":"The House Type for the PO address\n" }, "number1":{ "type":"string", "maxLength":6, "description":"Address number 1 for the PO address" }, "number2":{ "type":"string", "maxLength":4, "description":"Address number 2 for the PO address" }, "geographicCode":{ "type":"string", "maxLength":11, "description":"The Geographic Code for the PO address" }, "inCityLimit":{ "type":"boolean", "description":"Indicates whether or not this address is within the taxing boundary of the jurisdiction that's provided in the address." }, "city":{ "type":"string", "maxLength":90, "description":"The City for the PO address", "example":"Washington" }, "suburb":{ "type":"string", "maxLength":64, "description":"The Suburb for the PO address" }, "county":{ "type":"string", "maxLength":90, "description":"The County for the PO address", "example":"US" }, "state":{ "type":"string", "maxLength":6, "description":"The Postal Code for the PO address", "example":"District of Columbia" }, "postal":{ "type":"string", "maxLength":12, "description":"The Postal Code for the PO address", "example":"20001" }, "country":{ "type":"string", "maxLength":3, "description":"The Country Code for the PO address" } } }, "currency":{ "type":"string", "maxLength":3, "description":"Currency Code", "example":"United States Dollars" }, "exchangeRate":{ "type":"number", "maximum":"100000000000", "minimum":0, "description":"The rate to convert the currency code values to the default currency.", "example":"1.5" }, "freeOnBoard":{ "type":"string", "maxLength":30, "description":"Determines the costs involved in the delivery of goods." }, "paymentTerms":{ "type":"string", "maxLength":30, "description":"Payment terms between payee and vendor.", "example":"CM-Pay30Days" }, "purchaseDocumentType":{ "type":"string", "enum":[ "W1GP", "W1SR" ], "description":"Indicates where the purchase order is being generated from.\n* `W1GP` - General Purchase,\n* `W1SR` - Store Replenishment", "example":"W1GP" } } }, "lines":{ "type":"object", "properties":{ "_data":{ "type":"array", "items":{ "type":"object", "properties":{ "purchaseOrderLineExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "status":{ "type":"string", "maxLength":12, "description":"Status of the purchase order based on business object lifecycle.", "example":"ISSUED" }, "description":{ "type":"string", "maxLength":100, "description":"Descriptive information about the revision.", "example":"Meter For Central Storeroom" }, "lineNumber":{ "type":"number", "maximum":999, "minimum":0, "description":"The number referencing each Purchase Order Line. These should be unique between lines.", "example":"1" }, "purchaseRequisitionLineId":{ "type":"string", "maxLength":14, "description":"Work and Asset Management Purchase Requisition Line ID sent out during the Purchase Requisition Sync.", "example":"97680207221035" }, "blanketContractLineExternalId":{ "type":"string", "maxLength":60, "description":"External ID" }, "blanketContractNumber":{ "type":"string", "maxLength":14, "description":"Blanket Contract Number" }, "blanketContractLineNumber":{ "type":"number", "maximum":999, "minimum":0, "description":"The number referencing each Purchase Order Line. These should be unique between lines.", "example":"1" }, "itemType":{ "type":"string", "enum":[ "W1MC", "W1MT", "W1SV" ], "description":"Item type\n* `W1MC` - Miscellaneous,\n* `W1MT` - Materials,\n* `W1SV` - Services", "example":"W1MT" }, "quantity":{ "type":"number", "maximum":"99999999.99999", "minimum":0, "description":"Purchase Order quantity", "example":"20" }, "unitPrice":{ "type":"number", "maximum":"100000000000", "minimum":"-100000000000", "description":"Purchase Order Unit Price", "example":"40" }, "unitOfPurchase":{ "type":"string", "maxLength":30, "description":"Purchase Order unit Of Purchase", "example":"WD-EACH" }, "purchaseToIssueRatio":{ "type":"number", "maximum":99999999, "minimum":0, "description":"Purchase to Issue Ratio" }, "requiredDate":{ "type":"string", "format":"date", "description":"The date a purchase order is required by the requestor.", "example":"2021-09-30" }, "promiseDate":{ "type":"string", "format":"date", "description":"Purchase Order Promise Date", "example":"2021-09-28" }, "vendorPartNumber":{ "type":"string", "maxLength":60, "description":"Purchase Order vendorPartNumber", "example":"ASMON1" }, "lineAmount":{ "type":"number", "description":"Purchase Order line amount", "example":"800" } } } } } } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)" } } } } } } }, "W1AdStkItmSy_response":{ "type":"object", "properties":{ "W1AdStkItmSy":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.", "example":"ERP" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.", "example":"300000228404035" }, "initialLoad":{ "type":"string", "maxLength":4, "description":"Indicates how the sync request is initiated by the external system, for example by a mass load like conversion.", "example":"F1IL" }, "stockItemInfo":{ "type":"object", "properties":{ "resourceTypeExternalId":{ "type":"string", "maxLength":60, "description":"External ID", "example":"300000228404035" }, "boStatus":{ "type":"string", "maxLength":12, "description":"Status of the item based on business object lifecycle.", "example":"Active" }, "statusReason":{ "type":"string", "maxLength":30, "description":"Additional information about why a stock item transitioned to a new status.", "example":"" }, "description":{ "type":"string", "maxLength":100, "description":"Brief description up to 100 characters for the stock item.", "example":"Residential Gas Meter" }, "longDescription":{ "type":"string", "maxLength":4000, "description":"Longer description up to 4000 characters for the stock item.", "example":"Meter, Flow, FMU861, Endress-Hauser" }, "stockItem":{ "type":"string", "maxLength":60, "description":"The unique record IDs of the stock item, used as the stock code in Work and Asset Management.", "example":"0000001" }, "inventoryExpenseCode":{ "type":"string", "maxLength":30, "description":"Indicates the expense code that will be charged for costs related to the storeroom housing the stock item. If specified, it overrides the Inventory Expense Code on the storeroom.", "example":"WD-Inventory" }, "usageExpenseCode":{ "type":"string", "maxLength":30, "description":"Indicates the expense code that will be charged for costs related to the stock item being utilized.", "example":"WD-Inventory" }, "propertyUnit":{ "type":"string", "maxLength":30, "description":"Property units are associated with stock items to indicate when a compatible unit of that stock item is built and should be used to create a fixed asset.", "example":"Blade" }, "unitPrice":{ "type":"number", "maximum":"100000000000", "minimum":"-100000000000", "description":"The average unit price at the unit of issue. Users can update it for a brand new stock item for a cost estimate.", "example":"$8900.00" }, "commodityCategory":{ "type":"string", "maxLength":30, "description":"The highest level, or most general categorization of an item.", "example":"Mechanical Items" }, "commodityName":{ "type":"string", "maxLength":30, "description":"For each category, there is a unique list of Commodity Names.", "example":"Check Valve." }, "commodityType":{ "type":"string", "maxLength":30, "description":"For each category and name combination, there is a unique list of Commodity Types.", "example":"High-pressure pneumatic check valve." }, "commodityComposition":{ "type":"string", "maxLength":30, "description":"For each category, name, and type combination, there is a unique list of Commodity Compositions. The composition code is used to indicate the primary material in the item.", "example":"Titanium alloy" }, "commoditySize":{ "type":"number", "maximum":0, "minimum":0, "description":"Commodity Size ID (number) provided by ERP", "example":"12" }, "stockCategory":{ "type":"string", "enum":[ "ZZCL", "ZZCN", "ZZEE", "ZZME", "ZZSF" ], "description":"Categorization for stock items based on your organization's business practices.", "example":"WDBE" }, "hazardous":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether the item may be hazardous in some way.", "example":"W1YS" }, "hazardousType":{ "type":"string", "enum":[ "ZZ01", "ZZCH", "ZZEL" ], "description":"Indicates the type of hazard for hazardous items.", "example":"GDAC" }, "lotManaged":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Lot Managed:\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"W1YS" }, "shelfLife":{ "type":"number", "maximum":999999, "minimum":0, "description":"Indicates the number of days that perishable items can remain in stores before it is no longer useful.", "example":"120" }, "capitalSpare":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether the item is a relatively valuable piece of equipment kept in the house as a backup if the item in use should fail. Items such as a spare motor or generator might fall into this category.", "example":"W1NO" }, "trackable":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether the item is trackable. Trackable stock items merit being individually identified and followed from initial receipt on-site through complete usage. These are typically large, expensive, or specialized assets or materials, which are inspected when they are received into inventory, repaired if they break, can be installed on other assets, and are otherwise carefully dispositioned in the system.", "example":"W1NO" }, "repairable":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether or not the item is eligible to be repaired, should it fail.", "example":"W1YS" }, "unitOfPurchase":{ "type":"string", "maxLength":30, "description":"The Unit of Purchase defines the type of unit used to order an item, such as BOX. The system uses the Unit of Purchase, Unit of Issue, and Purchase to Issue Ratio information to maintain quantities as parts are issued and new parts are received. You may, for instance, issue in individual items but order the items by the box where one box would contain 10 individual items. In this scenario, the Unit of Purchase is BOX, the Unit of Issue is Each, and the Purchase to Issue Ratio is 10.", "example":"WD-Each" }, "unitOfIssue":{ "type":"string", "maxLength":30, "description":"The Unit of Issue defines the type of unit used to issue an item.The system uses the Unit of Purchase, Unit of Issue, and Purchase to Issue Ratio information to maintain quantities as parts are issued and new parts are received. You may, for instance, issue in individual items but order the items by the box where one box would contain 10 individual items. In this scenario, the Unit of Purchase is BOX, the Unit of Issue is Each, and the Purchase to Issue Ratio is 10.", "example":"WD-Each" }, "purchaseToIssueRatio":{ "type":"number", "maximum":99999999, "minimum":0, "description":"The system calculates the Purchase to Issue Ratio using the Unit of Purchase by the Unit of Issue. For instance, issue in individual items but order the items by the box where one box would contain 10 individual items. The Unit of Purchase would then be BOX, the Unit of Issue would be EACH, and the P-I ratio would be 10.", "example":"10" }, "taxRateSchedule":{ "type":"string", "maxLength":30, "description":"Indicates the tax schedule applicable to the purchase. The drop-down list is defined by entries in the Tax Rate Schedule portal.", "example":"" }, "purchaseCommodity":{ "type":"string", "maxLength":30, "description":"The commodity classification for the stock item.", "example":"Mechanical" }, "doNotSubstitute":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates that you do not want the vendor to substitute the item with an alternate.", "example":"W1YS" }, "defaultValueToActivity":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether or not the stock item information should default onto activities when resource requirements reference the stock item. If this is set to No, then the stock item can only be added to stock item details as a direct purchase item.", "example":"W1YS" }, "vendors":{ "type":"object", "properties":{ "vendorsList":{ "type":"array", "items":{ "type":"object", "properties":{ "vendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"External ID", "example":"WD-AGMElectronics" }, "vendorLocationId":{ "type":"string", "maxLength":12, "description":"One or many vendor locations are defined for each vendor to distinguish between multiple vendor sites. Each location provides more detailed information about the vendor site such as an address, capabilities, payment details, contacts, and so on.", "example":"000123456789" }, "vendorPartNumber":{ "type":"string", "maxLength":60, "description":"A number that uniquely identifies the supplier part.", "example":"5.76382" }, "vendorPriority":{ "type":"string", "enum":[ "W1OT", "W1PR" ], "description":"Used to denote which is the primary supplier of the item. At least one vendor must be set as primary.", "example":"W1PR" } } } } } }, "manufacturers":{ "type":"object", "properties":{ "manufacturersList":{ "type":"array", "items":{ "type":"object", "properties":{ "manufacturerCode":{ "type":"string", "maxLength":30, "description":"Display the manufacturer of the asset.", "example":"WD-ABCElectronics" }, "copyToPO":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether a manufacturer should be copied to a purchasing document when it references this particular stock item.", "example":"W1YS" }, "manufacturerPartNumber":{ "type":"string", "maxLength":60, "description":"A number that uniquely identifies the manufacturer part", "example":"4.978284" }, "bomId":{ "type":"string", "maxLength":12, "description":"A Bill of Material (BOM) is a list containing a hierarchy of component parts that make up a piece of equipment or asset. The component parts, also known as BOM Parts, are the individual stock items or an assembly of stock items included in the BOM", "example":"000123456789" } } } } } } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)" } } } } } } }, "W1AdStkItmSy_error":{ "type":"object", "properties":{ "problemDetailDocument":{ "type":"object", "properties":{ "problemType":{ "type":"string", "maxLength":60, "description":"URL of the format 'A/message/X/Y' where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework." }, "title":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "httpStatus":{ "type":"number", "maximum":9999, "minimum":0, "description":"The HTTP Status code for the error." }, "detail":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." }, "problemInstance":{ "type":"string", "maxLength":60, "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction." }, "stackTrace":{ "type":"string", "maxLength":60, "description":"The stack trace shows where the error occurs during the execution of a program." }, "serverMessage":{ "type":"object", "properties":{ "messageCategory":{ "type":"number", "maximum":0, "minimum":0, "description":"Message Category within Oracle Utilities Application Framework." }, "messageNbr":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework." }, "callSequence":{ "type":"string", "maxLength":60, "description":"Delimited sequence of programs called." }, "programName":{ "type":"string", "maxLength":60, "description":"Name of the program that encountered the error." }, "messageText":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "longDescription":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." } } } } } } }, "W1AdStkItmSy_request":{ "type":"object", "properties":{ "W1AdStkItmSy":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.", "example":"ERP" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.", "example":"300000228404035" }, "initialLoad":{ "type":"string", "maxLength":4, "description":"Indicates how the sync request is initiated by the external system, for example by a mass load like conversion.", "example":"F1IL" }, "stockItemInfo":{ "type":"object", "properties":{ "resourceTypeExternalId":{ "type":"string", "maxLength":60, "description":"External ID", "example":"300000228404035" }, "boStatus":{ "type":"string", "maxLength":12, "description":"Status of the item based on business object lifecycle.", "example":"Active" }, "statusReason":{ "type":"string", "maxLength":30, "description":"Additional information about why a stock item transitioned to a new status.", "example":"" }, "description":{ "type":"string", "maxLength":100, "description":"Brief description up to 100 characters for the stock item.", "example":"Residential Gas Meter" }, "longDescription":{ "type":"string", "maxLength":4000, "description":"Longer description up to 4000 characters for the stock item.", "example":"Meter, Flow, FMU861, Endress-Hauser" }, "stockItem":{ "type":"string", "maxLength":60, "description":"The unique record IDs of the stock item, used as the stock code in Work and Asset Management.", "example":"0000001" }, "inventoryExpenseCode":{ "type":"string", "maxLength":30, "description":"Indicates the expense code that will be charged for costs related to the storeroom housing the stock item. If specified, it overrides the Inventory Expense Code on the storeroom.", "example":"WD-Inventory" }, "usageExpenseCode":{ "type":"string", "maxLength":30, "description":"Indicates the expense code that will be charged for costs related to the stock item being utilized.", "example":"WD-Inventory" }, "propertyUnit":{ "type":"string", "maxLength":30, "description":"Property units are associated with stock items to indicate when a compatible unit of that stock item is built and should be used to create a fixed asset.", "example":"Blade" }, "unitPrice":{ "type":"number", "maximum":"100000000000", "minimum":"-100000000000", "description":"The average unit price at the unit of issue. Users can update it for a brand new stock item for a cost estimate.", "example":"$8900.00" }, "commodityCategory":{ "type":"string", "maxLength":30, "description":"The highest level, or most general categorization of an item.", "example":"Mechanical Items" }, "commodityName":{ "type":"string", "maxLength":30, "description":"For each category, there is a unique list of Commodity Names.", "example":"Check Valve." }, "commodityType":{ "type":"string", "maxLength":30, "description":"For each category and name combination, there is a unique list of Commodity Types.", "example":"High-pressure pneumatic check valve." }, "commodityComposition":{ "type":"string", "maxLength":30, "description":"For each category, name, and type combination, there is a unique list of Commodity Compositions. The composition code is used to indicate the primary material in the item.", "example":"Titanium alloy" }, "commoditySize":{ "type":"number", "maximum":0, "minimum":0, "description":"Commodity Size ID (number) provided by ERP", "example":"12" }, "stockCategory":{ "type":"string", "enum":[ "ZZCL", "ZZCN", "ZZEE", "ZZME", "ZZSF" ], "description":"Categorization for stock items based on your organization's business practices.", "example":"WDBE" }, "hazardous":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether the item may be hazardous in some way.", "example":"W1YS" }, "hazardousType":{ "type":"string", "enum":[ "ZZ01", "ZZCH", "ZZEL" ], "description":"Indicates the type of hazard for hazardous items.", "example":"GDAC" }, "lotManaged":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Lot Managed:\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"W1YS" }, "shelfLife":{ "type":"number", "maximum":999999, "minimum":0, "description":"Indicates the number of days that perishable items can remain in stores before it is no longer useful.", "example":"120" }, "capitalSpare":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether the item is a relatively valuable piece of equipment kept in the house as a backup if the item in use should fail. Items such as a spare motor or generator might fall into this category.", "example":"W1NO" }, "trackable":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether the item is trackable. Trackable stock items merit being individually identified and followed from initial receipt on-site through complete usage. These are typically large, expensive, or specialized assets or materials, which are inspected when they are received into inventory, repaired if they break, can be installed on other assets, and are otherwise carefully dispositioned in the system.", "example":"W1NO" }, "repairable":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether or not the item is eligible to be repaired, should it fail.", "example":"W1YS" }, "unitOfPurchase":{ "type":"string", "maxLength":30, "description":"The Unit of Purchase defines the type of unit used to order an item, such as BOX. The system uses the Unit of Purchase, Unit of Issue, and Purchase to Issue Ratio information to maintain quantities as parts are issued and new parts are received. You may, for instance, issue in individual items but order the items by the box where one box would contain 10 individual items. In this scenario, the Unit of Purchase is BOX, the Unit of Issue is Each, and the Purchase to Issue Ratio is 10.", "example":"WD-Each" }, "unitOfIssue":{ "type":"string", "maxLength":30, "description":"The Unit of Issue defines the type of unit used to issue an item.The system uses the Unit of Purchase, Unit of Issue, and Purchase to Issue Ratio information to maintain quantities as parts are issued and new parts are received. You may, for instance, issue in individual items but order the items by the box where one box would contain 10 individual items. In this scenario, the Unit of Purchase is BOX, the Unit of Issue is Each, and the Purchase to Issue Ratio is 10.", "example":"WD-Each" }, "purchaseToIssueRatio":{ "type":"number", "maximum":99999999, "minimum":0, "description":"The system calculates the Purchase to Issue Ratio using the Unit of Purchase by the Unit of Issue. For instance, issue in individual items but order the items by the box where one box would contain 10 individual items. The Unit of Purchase would then be BOX, the Unit of Issue would be EACH, and the P-I ratio would be 10.", "example":"10" }, "taxRateSchedule":{ "type":"string", "maxLength":30, "description":"Indicates the tax schedule applicable to the purchase. The drop-down list is defined by entries in the Tax Rate Schedule portal.", "example":"" }, "purchaseCommodity":{ "type":"string", "maxLength":30, "description":"The commodity classification for the stock item.", "example":"Mechanical" }, "doNotSubstitute":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates that you do not want the vendor to substitute the item with an alternate.", "example":"W1YS" }, "defaultValueToActivity":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether or not the stock item information should default onto activities when resource requirements reference the stock item. If this is set to No, then the stock item can only be added to stock item details as a direct purchase item.", "example":"W1YS" }, "vendors":{ "type":"object", "properties":{ "vendorsList":{ "type":"array", "items":{ "type":"object", "properties":{ "vendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"External ID", "example":"WD-AGMElectronics" }, "vendorLocationId":{ "type":"string", "maxLength":12, "description":"One or many vendor locations are defined for each vendor to distinguish between multiple vendor sites. Each location provides more detailed information about the vendor site such as an address, capabilities, payment details, contacts, and so on.", "example":"000123456789" }, "vendorPartNumber":{ "type":"string", "maxLength":60, "description":"A number that uniquely identifies the supplier part.", "example":"5.76382" }, "vendorPriority":{ "type":"string", "enum":[ "W1OT", "W1PR" ], "description":"Used to denote which is the primary supplier of the item. At least one vendor must be set as primary.", "example":"W1PR" } } } } } }, "manufacturers":{ "type":"object", "properties":{ "manufacturersList":{ "type":"array", "items":{ "type":"object", "properties":{ "manufacturerCode":{ "type":"string", "maxLength":30, "description":"Display the manufacturer of the asset.", "example":"WD-ABCElectronics" }, "copyToPO":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates whether a manufacturer should be copied to a purchasing document when it references this particular stock item.", "example":"W1YS" }, "manufacturerPartNumber":{ "type":"string", "maxLength":60, "description":"A number that uniquely identifies the manufacturer part", "example":"4.978284" }, "bomId":{ "type":"string", "maxLength":12, "description":"A Bill of Material (BOM) is a list containing a hierarchy of component parts that make up a piece of equipment or asset. The component parts, also known as BOM Parts, are the individual stock items or an assembly of stock items included in the BOM", "example":"000123456789" } } } } } } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)" } } } } } } }, "UPDATEADDLEAVE_request":{ "type":"object", "properties":{ "W1UpdLeave":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The Work and Asset Management code that represents the external system.", "example":"HCM" }, "externalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "leaveType":{ "type":"string", "maxLength":30, "description":"Indicates the type of leave/unavailability for the employee", "example":"i.e. Vacation" }, "description":{ "type":"string", "maxLength":100, "description":"Short description", "example":"Casual Leave 5" }, "applicantId":{ "type":"string", "maxLength":12, "description":"Unique identification for the employee for integration with external systems." }, "applicantExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "status":{ "type":"string", "maxLength":12, "description":"Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected", "example":"Approved" }, "startDateTime":{ "type":"string", "format":"date-time", "description":"Indicates the start date/time period for the unavailability.", "example":"12-25-2018 04:00PM" }, "endDateTime":{ "type":"string", "format":"date-time", "description":"Indicates the end date/ time period for the unavailability.", "example":"12-31-2018 03:59PM" } } }, "output":{ "type":"object", "properties":{ "leaveId":{ "type":"string", "description":"(leaveId)" } } } } } } }, "UPDATEADDLEAVE_response":{ "type":"object", "properties":{ "W1UpdLeave":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The Work and Asset Management code that represents the external system.", "example":"HCM" }, "externalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "leaveType":{ "type":"string", "maxLength":30, "description":"Indicates the type of leave/unavailability for the employee", "example":"i.e. Vacation" }, "description":{ "type":"string", "maxLength":100, "description":"Short description", "example":"Casual Leave 5" }, "applicantId":{ "type":"string", "maxLength":12, "description":"Unique identification for the employee for integration with external systems." }, "applicantExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "status":{ "type":"string", "maxLength":12, "description":"Status of the Applicant record. The status can be set to one of the following values: Active, Approved, Canceled, Created, Expired, Pending Approval, Rejected", "example":"Approved" }, "startDateTime":{ "type":"string", "format":"date-time", "description":"Indicates the start date/time period for the unavailability.", "example":"12-25-2018 04:00PM" }, "endDateTime":{ "type":"string", "format":"date-time", "description":"Indicates the end date/ time period for the unavailability.", "example":"12-31-2018 03:59PM" } } }, "output":{ "type":"object", "properties":{ "leaveId":{ "type":"string", "description":"(leaveId)" } } } } } } }, "UPDATEADDLEAVE_error":{ "type":"object", "properties":{ "problemDetailDocument":{ "type":"object", "properties":{ "problemType":{ "type":"string", "maxLength":60, "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework." }, "title":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "httpStatus":{ "type":"number", "maximum":9999, "minimum":0, "description":"The HTTP Status code for the error." }, "detail":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." }, "problemInstance":{ "type":"string", "maxLength":60, "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction." }, "stackTrace":{ "type":"string", "maxLength":60, "description":"The stack trace shows where the error occurs during the execution of a program." }, "serverMessage":{ "type":"object", "properties":{ "messageCategory":{ "type":"number", "maximum":0, "minimum":0, "description":"Message Category within Oracle Utilities Application Framework." }, "messageNbr":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework." }, "callSequence":{ "type":"string", "maxLength":60, "description":"Delimited sequence of programs called." }, "programName":{ "type":"string", "maxLength":60, "description":"Name of the program that encountered the error." }, "messageText":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "longDescription":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." } } } } } } }, "SYNCVENDORLOCATION_error":{ "type":"object", "properties":{ "problemDetailDocument":{ "type":"object", "properties":{ "problemType":{ "type":"string", "maxLength":60, "description":"URL of the format 'A/message/X/Y' where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework." }, "title":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "httpStatus":{ "type":"number", "maximum":9999, "minimum":0, "description":"The HTTP Status code for the error." }, "detail":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." }, "problemInstance":{ "type":"string", "maxLength":60, "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction." }, "stackTrace":{ "type":"string", "maxLength":60, "description":"The stack trace shows where the error occurs during the execution of a program." }, "serverMessage":{ "type":"object", "properties":{ "messageCategory":{ "type":"number", "maximum":0, "minimum":0, "description":"Message Category within Oracle Utilities Application Framework." }, "messageNbr":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework." }, "callSequence":{ "type":"string", "maxLength":60, "description":"Delimited sequence of programs called." }, "programName":{ "type":"string", "maxLength":60, "description":"Name of the program that encountered the error." }, "messageText":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "longDescription":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." } } } } } } }, "SYNCVENDORLOCATION_response":{ "type":"object", "properties":{ "W1VndLocSyn":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.", "example":"ERP" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.", "example":"300000047414539" }, "initialLoad":{ "type":"string", "maxLength":4, "description":"Indicates how the sync request is initiated by the external system, for example by a mass load like conversion.", "example":"F1IL" }, "vendorLocation":{ "type":"object", "properties":{ "vendorExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value", "example":"300000047414503" }, "vendor":{ "type":"string", "maxLength":30, "description":"Unique identification for the vendor in Work and Asset Management. When vendor location(s) of a new vendor are synced into Work and Asset Management for the first time, a new vendor record is created with this as its primary key in the Vendor portal. This could be different from the unique identifier of the vendor in the external system.", "example":"XYZ" }, "vendorName":{ "type":"string", "maxLength":254, "description":"Vendor Name", "example":"Grainger Supply" }, "website":{ "type":"string", "maxLength":254, "description":"Website of the vendor", "example":"http://www.xyz.com" }, "status":{ "type":"string", "maxLength":12, "description":"Status of the vendor based on business object lifecycle.", "example":"ACTIVE" }, "vendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value", "example":"300000047414539" }, "locationName":{ "type":"string", "maxLength":254, "description":"Location Name", "example":"Grainger San Jose" }, "creationDateTime":{ "type":"string", "format":"date-time", "description":"The creation date and time of the vendor location. If left blank, it is defaulted to system date and time when it is created in Work and Asset Management", "example":"2013-11-07T20:16:59-08:00" }, "location":{ "type":"object", "properties":{ "address1":{ "type":"string", "maxLength":254, "description":"Vendor Address Line 1", "example":"5000 CARTER DR" }, "address2":{ "type":"string", "maxLength":254, "description":"Vendor Address Line 2", "example":"" }, "address3":{ "type":"string", "maxLength":254, "description":"Vendor Address Line 3", "example":"" }, "address4":{ "type":"string", "maxLength":254, "description":"Vendor Address Line 4", "example":"" }, "crossStreet":{ "type":"string", "maxLength":64, "description":"Vendor Cross Street", "example":"" }, "houseType":{ "type":"string", "enum":[ ], "description":"Vendor House TypeHouse Type:\n", "example":"" }, "number1":{ "type":"string", "maxLength":6, "description":"Vendor Address Number 1", "example":"" }, "number2":{ "type":"string", "maxLength":4, "description":"Vendor Address Number 2", "example":"" }, "geographicCode":{ "type":"string", "maxLength":11, "description":"Vendor Geographical Code", "example":"" }, "inCityLimit":{ "type":"boolean", "description":"Vendor In City Limit", "example":"" }, "city":{ "type":"string", "maxLength":90, "description":"Vendor City", "example":"LOS ANGELES" }, "suburb":{ "type":"string", "maxLength":64, "description":"Vendor Suburb", "example":"" }, "county":{ "type":"string", "maxLength":90, "description":"Vendor County", "example":"LOS ANGELES" }, "state":{ "type":"string", "maxLength":6, "description":"Vendor State", "example":"CA" }, "postal":{ "type":"string", "maxLength":12, "description":"Vendor Postal", "example":"90032" }, "country":{ "type":"string", "maxLength":3, "description":"Vendor Country", "example":"US" } } }, "orderFromFlag":{ "type":"string", "enum":[ "W1AL", "W1NA" ], "description":"Indicates whether or not the vendor location accepts orders.Order From:\n* `W1AL` - Allowed,\n* `W1NA` - Not Allowed", "example":"W1AL" }, "payToFlag":{ "type":"string", "enum":[ "W1AL", "W1NA" ], "description":"Indicates whether or not the vendor location handles its own billing.Pay To:\n* `W1AL` - Allowed,\n* `W1NA` - Not Allowed", "example":"W1AL" }, "payToVendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value", "example":"300000047414543" }, "currency":{ "type":"string", "maxLength":3, "description":"Foreign Key (FK) to Currency Type", "example":"United States Dollars" }, "paymentTerm":{ "type":"string", "maxLength":30, "description":"Indicates the terms for paying the vendor such as Net 30. This field is controlled by the Payment Terms portal.", "example":"Net 30" }, "minimumOrderAmount":{ "type":"number", "description":"Indicates a dollar amount which is the minimum the vendor location will accept for one order.", "example":"100" }, "autoPay":{ "type":"string", "maxLength":4, "description":"Indicates that an invoice will be automatically created for the purchase order upon receipt.", "example":"W1YS" }, "carrierFlag":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"This indicates if the location provides shipping (for example referenced on purchase orders and purchase requests as a carrier.Carrier:\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"W1YS" }, "carrierLocationId":{ "type":"string", "maxLength":12, "description":"This is the location used if the location does not provide shipping. This field is required if Carrier Flag is set to No, otherwise, should not be populated.", "example":"691714579103" }, "fob":{ "type":"string", "maxLength":30, "description":"Free on board code. This field is controlled by the Free on Board portal.", "example":"WD-OriginFreightCollected" }, "emailPoFlag":{ "type":"string", "enum":[ "W1AL", "W1NA" ], "description":"Indicates whether or not purchase orders should be emailed to this vendor location. After the purchase order is issued, an option becomes available under Additional Processes to email the order.Email PO:\n* `W1AL` - Allowed,\n* `W1NA` - Not Allowed", "example":"W1AL" }, "poEmailAddress":{ "type":"string", "maxLength":70, "description":"The email address where purchase orders should be sent for this location. This is required if Email PO is allowed.", "example":"xyz@domain.com" }, "payTaxToVendor":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Pay Tax To Vendor:\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"W1YS" } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)", "example":"24159624001247" } } } } } } }, "SYNCVENDORLOCATION_request":{ "type":"object", "properties":{ "W1VndLocSyn":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.", "example":"ERP" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.", "example":"300000047414539" }, "initialLoad":{ "type":"string", "maxLength":4, "description":"Indicates how the sync request is initiated by the external system, for example by a mass load like conversion.", "example":"F1IL" }, "vendorLocation":{ "type":"object", "properties":{ "vendorExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value", "example":"300000047414503" }, "vendor":{ "type":"string", "maxLength":30, "description":"Unique identification for the vendor in Work and Asset Management. When vendor location(s) of a new vendor are synced into Work and Asset Management for the first time, a new vendor record is created with this as its primary key in the Vendor portal. This could be different from the unique identifier of the vendor in the external system.", "example":"XYZ" }, "vendorName":{ "type":"string", "maxLength":254, "description":"Vendor Name", "example":"Grainger Supply" }, "website":{ "type":"string", "maxLength":254, "description":"Website of the vendor", "example":"http://www.xyz.com" }, "status":{ "type":"string", "maxLength":12, "description":"Status of the vendor based on business object lifecycle.", "example":"ACTIVE" }, "vendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value", "example":"300000047414539" }, "locationName":{ "type":"string", "maxLength":254, "description":"Location Name", "example":"Grainger San Jose" }, "creationDateTime":{ "type":"string", "format":"date-time", "description":"The creation date and time of the vendor location. If left blank, it is defaulted to system date and time when it is created in Work and Asset Management", "example":"2013-11-07T20:16:59-08:00" }, "location":{ "type":"object", "properties":{ "address1":{ "type":"string", "maxLength":254, "description":"Vendor Address Line 1", "example":"5000 CARTER DR" }, "address2":{ "type":"string", "maxLength":254, "description":"Vendor Address Line 2" }, "address3":{ "type":"string", "maxLength":254, "description":"Vendor Address Line 3" }, "address4":{ "type":"string", "maxLength":254, "description":"Vendor Address Line 4" }, "crossStreet":{ "type":"string", "maxLength":64, "description":"Vendor Cross Street" }, "houseType":{ "type":"string", "enum":[ ], "description":"Vendor House TypeHouse Type:\n" }, "number1":{ "type":"string", "maxLength":6, "description":"Vendor Address Number 1" }, "number2":{ "type":"string", "maxLength":4, "description":"Vendor Address Number 2" }, "geographicCode":{ "type":"string", "maxLength":11, "description":"Vendor Geographical Code" }, "inCityLimit":{ "type":"boolean", "description":"Vendor In City Limit" }, "city":{ "type":"string", "maxLength":90, "description":"Vendor City", "example":"LOS ANGELES" }, "suburb":{ "type":"string", "maxLength":64, "description":"Vendor Suburb" }, "county":{ "type":"string", "maxLength":90, "description":"Vendor County", "example":"LOS ANGELES" }, "state":{ "type":"string", "maxLength":6, "description":"Vendor State", "example":"CA" }, "postal":{ "type":"string", "maxLength":12, "description":"Vendor Postal", "example":"90032" }, "country":{ "type":"string", "maxLength":3, "description":"Vendor Country", "example":"US" } } }, "orderFromFlag":{ "type":"string", "enum":[ "W1AL", "W1NA" ], "description":"Indicates whether or not the vendor location accepts orders.Order From:\n* `W1AL` - Allowed,\n* `W1NA` - Not Allowed", "example":"W1AL" }, "payToFlag":{ "type":"string", "enum":[ "W1AL", "W1NA" ], "description":"Indicates whether or not the vendor location handles its own billing.Pay To:\n* `W1AL` - Allowed,\n* `W1NA` - Not Allowed", "example":"W1AL" }, "payToVendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value", "example":"300000047414543" }, "currency":{ "type":"string", "maxLength":3, "description":"Foreign Key (FK) to Currency Type", "example":"United States Dollars" }, "paymentTerm":{ "type":"string", "maxLength":30, "description":"Indicates the terms for paying the vendor such as Net 30. This field is controlled by the Payment Terms portal.", "example":"Net 30" }, "minimumOrderAmount":{ "type":"number", "description":"Indicates a dollar amount which is the minimum the vendor location will accept for one order.", "example":"100" }, "autoPay":{ "type":"string", "maxLength":4, "description":"Indicates that an invoice will be automatically created for the purchase order upon receipt.", "example":"W1YS" }, "carrierFlag":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"This indicates if the location provides shipping (for example referenced on purchase orders and purchase requests as a carrier.Carrier:\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"W1YS" }, "carrierLocationId":{ "type":"string", "maxLength":12, "description":"This is the location used if the location does not provide shipping. This field is required if Carrier Flag is set to No, otherwise, should not be populated.", "example":"691714579103" }, "fob":{ "type":"string", "maxLength":30, "description":"Free on board code. This field is controlled by the Free on Board portal.", "example":"WD-OriginFreightCollected" }, "emailPoFlag":{ "type":"string", "enum":[ "W1AL", "W1NA" ], "description":"Indicates whether or not purchase orders should be emailed to this vendor location. After the purchase order is issued, an option becomes available under Additional Processes to email the order.Email PO:\n* `W1AL` - Allowed,\n* `W1NA` - Not Allowed", "example":"W1AL" }, "poEmailAddress":{ "type":"string", "maxLength":70, "description":"The email address where purchase orders should be sent for this location. This is required if Email PO is allowed.", "example":"xyz@domain.com" }, "payTaxToVendor":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Pay Tax To Vendor:\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"W1YS" } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)", "example":"24159624001247" } } } } } } }, "SYNCINVOICE_request":{ "type":"object", "properties":{ "W1InvoiceSyn":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.", "example":"ERP" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.", "example":"300000230447674" }, "invoice":{ "type":"object", "properties":{ "header":{ "type":"object", "properties":{ "invoiceHeaderExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "invoiceNumber":{ "type":"string", "maxLength":30, "description":"This is the vendor's invoice number and it is unique for each vendor location.", "example":"170000004-0001" }, "description":{ "type":"string", "maxLength":100, "description":"Brief description up to 100 characters for the invoice.", "example":"Gearbox Order for Wind Tower" }, "vendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"External ID" }, "payToVendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"External ID" }, "paymentTerms":{ "type":"string", "maxLength":30, "description":"Invoice Payment Terms", "example":"CM-Pay30Days" }, "numberOfDays":{ "type":"number", "maximum":99, "minimum":0, "description":"Payment due in number of days.", "example":"30" }, "vendorDate":{ "type":"string", "format":"date", "description":"The date on which invoice is generated by vendor.", "example":"2021-09-15" }, "invoiceDueDate":{ "type":"string", "format":"date", "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)", "example":"2021-10-15" }, "invoiceReceivedDate":{ "type":"string", "format":"date", "description":"Invoice received date", "example":"2021-09-15" }, "invoiceEnteredDate":{ "type":"string", "format":"date", "description":"Invoice entered date", "example":"2021-09-15" }, "currency":{ "type":"string", "maxLength":3, "description":"Currency Code", "example":"USD" }, "exchangeRate":{ "type":"number", "maximum":"100000000000", "minimum":0, "description":"Exchange Rate" }, "paymentDate":{ "type":"string", "format":"date", "description":"The date on which payment is done", "example":"2021-10-15" }, "paymentNumber":{ "type":"string", "maxLength":20, "description":"Payment number" }, "paymentType":{ "type":"string", "enum":[ "W1AP", "W1DR", "W1EL", "W1MN" ], "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual", "example":"W1DR" }, "paymentAmount":{ "type":"number", "description":"Amount paid", "example":"800" } } }, "lines":{ "type":"object", "properties":{ "_data":{ "type":"array", "items":{ "type":"object", "properties":{ "invoiceLineExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "purchaseOrderLineExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "purchaseOrderNumber":{ "type":"string", "maxLength":14, "description":"Enterprise Resource Planning system generated Purchase Order number.", "example":"US164237" }, "purchaseOrderLineNumber":{ "type":"number", "maximum":999, "minimum":0, "description":"Item Number" }, "description":{ "type":"string", "maxLength":100, "description":"Brief description up to 100 characters for the invoice.", "example":"Gearbox Order for Wind Tower" }, "itemType":{ "type":"string", "enum":[ "W1CP", "W1CR", "W1DS", "W1FR", "W1NR", "W1TX", "W1XR" ], "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost" }, "quantity":{ "type":"number", "maximum":"99999999.99999", "minimum":0, "description":"Invoice quantity", "example":"20" }, "unitPrice":{ "type":"number", "maximum":"100000000000", "minimum":"-100000000000", "description":"Invoice Unit Price", "example":"40" }, "lineAmount":{ "type":"number", "description":"Invoice line amount", "example":"800" } } } } } } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)" } } } } } } }, "SYNCINVOICE_error":{ "type":"object", "properties":{ "problemDetailDocument":{ "type":"object", "properties":{ "problemType":{ "type":"string", "maxLength":60, "description":"URL of the format 'A/message/X/Y' where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework." }, "title":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "httpStatus":{ "type":"number", "maximum":9999, "minimum":0, "description":"The HTTP Status code for the error." }, "detail":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." }, "problemInstance":{ "type":"string", "maxLength":60, "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction." }, "stackTrace":{ "type":"string", "maxLength":60, "description":"The stack trace shows where the error occurs during the execution of a program." }, "serverMessage":{ "type":"object", "properties":{ "messageCategory":{ "type":"number", "maximum":0, "minimum":0, "description":"Message Category within Oracle Utilities Application Framework." }, "messageNbr":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework." }, "callSequence":{ "type":"string", "maxLength":60, "description":"Delimited sequence of programs called." }, "programName":{ "type":"string", "maxLength":60, "description":"Name of the program that encountered the error." }, "messageText":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "longDescription":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." } } } } } } }, "SYNCINVOICE_response":{ "type":"object", "properties":{ "W1InvoiceSyn":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"The default value for the Enterprise Resource Planning Integration. You can retrieve the correct value from the property name wacs.externalsystem in the ERPWACS_ConfigProps file. This value must be defined for Work and Asset Management to function properly.", "example":"ERP" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Represents Enterprise Resource Planning's unique system-generated invoice ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.", "example":"300000230447674" }, "invoice":{ "type":"object", "properties":{ "header":{ "type":"object", "properties":{ "invoiceHeaderExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "invoiceNumber":{ "type":"string", "maxLength":30, "description":"This is the vendor's invoice number and it is unique for each vendor location.", "example":"170000004-0001" }, "description":{ "type":"string", "maxLength":100, "description":"Brief description up to 100 characters for the invoice.", "example":"Gearbox Order for Wind Tower" }, "vendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"External ID" }, "payToVendorLocationExternalId":{ "type":"string", "maxLength":60, "description":"External ID" }, "paymentTerms":{ "type":"string", "maxLength":30, "description":"Invoice Payment Terms", "example":"CM-Pay30Days" }, "numberOfDays":{ "type":"number", "maximum":99, "minimum":0, "description":"Payment due in number of days.", "example":"30" }, "vendorDate":{ "type":"string", "format":"date", "description":"The date on which invoice is generated by vendor.", "example":"2021-09-15" }, "invoiceDueDate":{ "type":"string", "format":"date", "description":"Invoice Due Date - Calculated based on the terms (vendor date + Days from Terms)", "example":"2021-10-15" }, "invoiceReceivedDate":{ "type":"string", "format":"date", "description":"Invoice received date", "example":"2021-09-15" }, "invoiceEnteredDate":{ "type":"string", "format":"date", "description":"Invoice entered date", "example":"2021-09-15" }, "currency":{ "type":"string", "maxLength":3, "description":"Currency Code", "example":"United States Dollars" }, "exchangeRate":{ "type":"number", "maximum":"100000000000", "minimum":0, "description":"Exchange Rate" }, "paymentDate":{ "type":"string", "format":"date", "description":"The date on which payment is done", "example":"2021-10-15" }, "paymentNumber":{ "type":"string", "maxLength":20, "description":"Payment number" }, "paymentType":{ "type":"string", "enum":[ "W1AP", "W1DR", "W1EL", "W1MN" ], "description":"Payment Type\n* `W1AP` - Regular AP Processing,\n* `W1DR` - Draft,\n* `W1EL` - Electronic,\n* `W1MN` - Manual", "example":"W1DR" }, "paymentAmount":{ "type":"number", "description":"Amount paid", "example":"800" } } }, "lines":{ "type":"object", "properties":{ "_data":{ "type":"array", "items":{ "type":"object", "properties":{ "invoiceLineExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "purchaseOrderLineExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "purchaseOrderNumber":{ "type":"string", "maxLength":14, "description":"Enterprise Resource Planning system generated Purchase Order number.", "example":"US164237" }, "purchaseOrderLineNumber":{ "type":"number", "maximum":999, "minimum":0, "description":"Item Number" }, "description":{ "type":"string", "maxLength":100, "description":"Brief description up to 100 characters for the invoice.", "example":"Gearbox Order for Wind Tower" }, "itemType":{ "type":"string", "enum":[ "W1CP", "W1CR", "W1DS", "W1FR", "W1NR", "W1TX", "W1XR" ], "description":"Invoice Item Type:\n* `W1CP` - Credit for Price Adjustment,\n* `W1CR` - Credit for Quantity Adjustment,\n* `W1DS` - Discount,\n* `W1FR` - Freight,\n* `W1NR` - Normal,\n* `W1TX` - Tax,\n* `W1XR` - Extra Cost" }, "quantity":{ "type":"number", "maximum":"99999999.99999", "minimum":0, "description":"Invoice quantity", "example":"20" }, "unitPrice":{ "type":"number", "maximum":"100000000000", "minimum":"-100000000000", "description":"Invoice Unit Price", "example":"40" }, "lineAmount":{ "type":"number", "description":"Invoice line amount", "example":"800" } } } } } } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)" } } } } } } }, "SYNCEMPLOYEE_request":{ "type":"object", "properties":{ "W1CreEmpSync":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"Defaulted (value) by the HCM Integration.", "example":"HCM" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Variable based on the originating system" }, "initialLoad":{ "type":"string", "maxLength":4, "description":"Defaulted (value) by the HCM Integration." }, "employeeInfo":{ "type":"object", "properties":{ "externalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "hrEmployeeNumber":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "employeeType":{ "type":"string", "maxLength":30, "description":"Employee Type", "example":"Regular" }, "businessUnit":{ "type":"string", "maxLength":30, "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.", "example":"US1" }, "status":{ "type":"string", "maxLength":12, "description":"Employee's Current Status.", "example":"ACTIVE or INACTIVE" }, "creationUser":{ "type":"string", "maxLength":8, "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system." }, "supervisor":{ "type":"string", "maxLength":12, "description":"The username of the employee's supervisor" }, "principalCraft":{ "type":"string", "maxLength":12, "description":"The main craft that the employee is qualified to work." }, "principalCraftExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "hiredDate":{ "type":"string", "format":"date", "description":"Employee's Hired Date." }, "jobTitle":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "jobCode":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "firstName":{ "type":"string", "maxLength":254, "description":"Employee's First Name." }, "lastName":{ "type":"string", "maxLength":254, "description":"Employee's Last Name." }, "emailAddress":{ "type":"string", "maxLength":254, "description":"Employee's Email address." }, "terminatedDate":{ "type":"string", "format":"date", "description":"Employee's Termination Date." }, "addressInformation":{ "type":"object", "properties":{ "address1":{ "type":"string", "maxLength":254, "description":"The first line for the address, associated with the Purchase Order." }, "address2":{ "type":"string", "maxLength":254, "description":"The second line for the address, associated with the Purchase Order." }, "address3":{ "type":"string", "maxLength":254, "description":"The third line for the address, associated with the Purchase Order." }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line for the address, associated with the Purchase Order." }, "crossStreet":{ "type":"string", "maxLength":64, "description":"The Cross Street the PO address." }, "houseType":{ "type":"string", "enum":[ ], "description":"The House Type for the PO address.\n" }, "number1":{ "type":"string", "maxLength":6, "description":"Street number 1" }, "number2":{ "type":"string", "maxLength":4, "description":"Street number 2" }, "geographicCode":{ "type":"string", "maxLength":11, "description":"The Geographic Code for the PO address." }, "inCityLimit":{ "type":"boolean", "description":"In City Limit" }, "city":{ "type":"string", "maxLength":90, "description":"The City for the PO address." }, "suburb":{ "type":"string", "maxLength":64, "description":"The Suburb for the PO address." }, "county":{ "type":"string", "maxLength":90, "description":"The County for the PO address.", "example":"US" }, "state":{ "type":"string", "maxLength":6, "description":"State", "example":"CA" }, "postal":{ "type":"string", "maxLength":12, "description":"The Postal Code for the PO address." }, "country":{ "type":"string", "maxLength":3, "description":"Country" } } }, "phoneNumbers":{ "type":"object", "properties":{ "phoneNumbersList":{ "type":"array", "items":{ "type":"object", "properties":{ "phoneType":{ "type":"string", "enum":[ "FAX ", "SMS ", "W1BS", "W1HM", "W1MB", "W1PR" ], "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary" }, "countryCode":{ "type":"string", "maxLength":3, "description":"Country" }, "areaCode":{ "type":"string", "maxLength":24, "description":"Phone" }, "phoneNumber":{ "type":"string", "maxLength":24, "description":"Phone" } } } } } }, "employeeTrainingInformation":{ "type":"object", "properties":{ "employeeTrainingInformationList":{ "type":"array", "items":{ "type":"object", "properties":{ "course":{ "type":"string", "maxLength":254, "description":"Training course number" }, "effectiveDate":{ "type":"string", "format":"date", "description":"Effective Date" }, "expirationDate":{ "type":"string", "format":"date", "description":"Expiration Date" }, "employeeNotified":{ "type":"boolean", "description":"Employee Notified" }, "supervisorNotified":{ "type":"boolean", "description":"Supervisor Notified" } } } } } }, "billableRates":{ "type":"object", "properties":{ "billableRatesList":{ "type":"array", "items":{ "type":"object", "properties":{ "effectiveDate":{ "type":"string", "format":"date", "description":"Billable rates effective date" }, "billableRate":{ "type":"number", "description":"Billable rate" } } } } } } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)" } } } } } } }, "SYNCEMPLOYEE_error":{ "type":"object", "properties":{ "problemDetailDocument":{ "type":"object", "properties":{ "problemType":{ "type":"string", "maxLength":60, "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework." }, "title":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "httpStatus":{ "type":"number", "maximum":9999, "minimum":0, "description":"The HTTP Status code for the error." }, "detail":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." }, "problemInstance":{ "type":"string", "maxLength":60, "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction." }, "stackTrace":{ "type":"string", "maxLength":60, "description":"The stack trace shows where the error occurs during the execution of a program." }, "serverMessage":{ "type":"object", "properties":{ "messageCategory":{ "type":"number", "maximum":0, "minimum":0, "description":"Message Category within Oracle Utilities Application Framework." }, "messageNbr":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework." }, "callSequence":{ "type":"string", "maxLength":60, "description":"Delimited sequence of programs called." }, "programName":{ "type":"string", "maxLength":60, "description":"Name of the program that encountered the error." }, "messageText":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "longDescription":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." } } } } } } }, "SYNCEMPLOYEE_response":{ "type":"object", "properties":{ "W1CreEmpSync":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"Defaulted (value) by the HCM Integration.", "example":"HCM" }, "externalReferenceId":{ "type":"string", "maxLength":36, "description":"Variable based on the originating system" }, "initialLoad":{ "type":"string", "maxLength":4, "description":"Defaulted (value) by the HCM Integration." }, "employeeInfo":{ "type":"object", "properties":{ "externalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "hrEmployeeNumber":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "employeeType":{ "type":"string", "maxLength":30, "description":"Employee Type", "example":"Regular" }, "businessUnit":{ "type":"string", "maxLength":30, "description":"The business unit that the employee belongs to. Generally costs incurred by the employee roll up to this business unit.", "example":"US1" }, "status":{ "type":"string", "maxLength":12, "description":"Employee's Current Status.", "example":"ACTIVE or INACTIVE" }, "creationUser":{ "type":"string", "maxLength":8, "description":"The system username for the employee. Employees do not necessarily have to be defined as users within the system." }, "supervisor":{ "type":"string", "maxLength":12, "description":"The username of the employee's supervisor" }, "principalCraft":{ "type":"string", "maxLength":12, "description":"The main craft that the employee is qualified to work." }, "principalCraftExternalId":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "hiredDate":{ "type":"string", "format":"date", "description":"Employee's Hired Date." }, "jobTitle":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "jobCode":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "firstName":{ "type":"string", "maxLength":254, "description":"Employee's First Name." }, "lastName":{ "type":"string", "maxLength":254, "description":"Employee's Last Name." }, "emailAddress":{ "type":"string", "maxLength":254, "description":"Employee's Email address." }, "terminatedDate":{ "type":"string", "format":"date", "description":"Employee's Termination Date." }, "addressInformation":{ "type":"object", "properties":{ "address1":{ "type":"string", "maxLength":254, "description":"The first line for the address, associated with the Purchase Order." }, "address2":{ "type":"string", "maxLength":254, "description":"The second line for the address, associated with the Purchase Order." }, "address3":{ "type":"string", "maxLength":254, "description":"The third line for the address, associated with the Purchase Order." }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line for the address, associated with the Purchase Order." }, "crossStreet":{ "type":"string", "maxLength":64, "description":"The Cross Street the PO address." }, "houseType":{ "type":"string", "enum":[ ], "description":"The House Type for the PO address.\n" }, "number1":{ "type":"string", "maxLength":6, "description":"Street number 1" }, "number2":{ "type":"string", "maxLength":4, "description":"Street number 2" }, "geographicCode":{ "type":"string", "maxLength":11, "description":"The Geographic Code for the PO address." }, "inCityLimit":{ "type":"boolean", "description":"In City Limit" }, "city":{ "type":"string", "maxLength":90, "description":"The City for the PO address." }, "suburb":{ "type":"string", "maxLength":64, "description":"The Suburb for the PO address." }, "county":{ "type":"string", "maxLength":90, "description":"The County for the PO address.", "example":"US" }, "state":{ "type":"string", "maxLength":6, "description":"State", "example":"CA" }, "postal":{ "type":"string", "maxLength":12, "description":"The Postal Code for the PO address." }, "country":{ "type":"string", "maxLength":3, "description":"Country" } } }, "phoneNumbers":{ "type":"object", "properties":{ "phoneNumbersList":{ "type":"array", "items":{ "type":"object", "properties":{ "phoneType":{ "type":"string", "enum":[ "FAX ", "SMS ", "W1BS", "W1HM", "W1MB", "W1PR" ], "description":"Phone number type\n* `FAX ` - Fax,\n* `SMS ` - Short Message Service,\n* `W1BS` - Business,\n* `W1HM` - Home,\n* `W1MB` - Mobile,\n* `W1PR` - Primary" }, "countryCode":{ "type":"string", "maxLength":3, "description":"Country" }, "areaCode":{ "type":"string", "maxLength":24, "description":"Phone" }, "phoneNumber":{ "type":"string", "maxLength":24, "description":"Phone" } } } } } }, "employeeTrainingInformation":{ "type":"object", "properties":{ "employeeTrainingInformationList":{ "type":"array", "items":{ "type":"object", "properties":{ "course":{ "type":"string", "maxLength":254, "description":"Training course number" }, "effectiveDate":{ "type":"string", "format":"date", "description":"Effective Date" }, "expirationDate":{ "type":"string", "format":"date", "description":"Expiration Date" }, "employeeNotified":{ "type":"boolean", "description":"Employee Notified" }, "supervisorNotified":{ "type":"boolean", "description":"Supervisor Notified" } } } } } }, "billableRates":{ "type":"object", "properties":{ "billableRatesList":{ "type":"array", "items":{ "type":"object", "properties":{ "effectiveDate":{ "type":"string", "format":"date", "description":"Billable rates effective date" }, "billableRate":{ "type":"number", "description":"Billable rate" } } } } } } } } } }, "output":{ "type":"object", "properties":{ "syncRequestId":{ "type":"string", "description":"(syncRequestId)" } } } } } } }, "CREATEORUPDATEPROJ_response":{ "type":"object", "properties":{ }, "xml":{ "name":"W1-CrePrjERP" } }, "CREATEORUPDATEPROJ_request":{ "type":"object", "properties":{ "projectCategory":{ "type":"string", "maxLength":30, "description":"Classification of project.", "example":"Maintenance" }, "managerName":{ "type":"string", "maxLength":254, "description":"The username of the person responsible for project.", "example":"JOHN" }, "managerEmail":{ "type":"string", "maxLength":70, "description":"The email of the person responsible for project." }, "erpReferenceNumber":{ "type":"string", "maxLength":60, "description":"If the ERP Project parameter is Yes, this should be the project number in ERP. if No this should be the ERP project task number.", "example":"0001 PJS CDRM AM" }, "erpProject":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Flag to indicate ERP Project, possible values are W1YS/W1NO If it's left blank, it's treated as No.\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"W1NO" }, "parentERPReferenceNumber":{ "type":"string", "maxLength":60, "description":"Project number in ERP." }, "parentERPProject":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"ERP Project flag of Parent.\n* `W1NO` - No,\n* `W1YS` - Yes" }, "description":{ "type":"string", "maxLength":100, "description":"Description of a project, if project already exists then the description of that project will be updated else the description will be used for new project." }, "allowCharge":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"When this indicator is set to \"yes\" other records can charge against the project.\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"W1NO" }, "budgetAmount":{ "type":"number", "description":"Indicates amount in respective currency for the project.", "example":"100" }, "estimatedStartDate":{ "type":"string", "format":"date", "description":"Indicates the estimated start date for the project.", "example":"2023-05-01" }, "estimatedEndDate":{ "type":"string", "format":"date", "description":"Indicates the estimated end date for the project.", "example":"2023-05-20" }, "actualStartDate":{ "type":"string", "format":"date", "description":"Indicates the actual start date for the project.", "example":"2023-05-01" }, "actualEndDate":{ "type":"string", "format":"date", "description":"Indicates actual end date for the project.", "example":"2023-05-20" }, "status":{ "type":"string", "maxLength":12, "description":"System code of the project status.", "example":"Started" }, "accountSegment1":{ "type":"string", "maxLength":254, "description":"Account Segment configured in ERP Integration Master Configuration." }, "accountSegment2":{ "type":"string", "maxLength":254, "description":"Account Segment configured in ERP Integration Master Configuration." }, "accountSegment3":{ "type":"string", "maxLength":254, "description":"Account Segment configured in ERP Integration Master Configuration." }, "accountSegment4":{ "type":"string", "maxLength":254, "description":"Account Segment configured in ERP Integration Master Configuration." }, "accountSegment5":{ "type":"string", "maxLength":254, "description":"Account Segment configured in ERP Integration Master Configuration." }, "accountSegment6":{ "type":"string", "maxLength":254, "description":"Account Segment configured in ERP Integration Master Configuration." }, "accountSegment7":{ "type":"string", "maxLength":254, "description":"Account Segment configured in ERP Integration Master Configuration." }, "accountSegment8":{ "type":"string", "maxLength":254, "description":"Account Segment configured in ERP Integration Master Configuration." }, "accountSegment9":{ "type":"string", "maxLength":254, "description":"Account Segment configured in ERP Integration Master Configuration." }, "accountSegment10":{ "type":"string", "maxLength":254, "description":"Account Segment configured in ERP Integration Master Configuration." }, "owningOrganization":{ "type":"string", "maxLength":12, "description":"Name of the owning organization that the project belongs to." } }, "xml":{ "name":"W1-CrePrjERP" } }, "W1-PRJACTDTL_error":{ "type":"object", "properties":{ "problemDetailDocument":{ "type":"object", "properties":{ "problemType":{ "type":"string", "maxLength":60, "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework." }, "title":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "httpStatus":{ "type":"number", "maximum":9999, "minimum":0, "description":"The HTTP Status code for the error." }, "detail":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." }, "problemInstance":{ "type":"string", "maxLength":60, "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction." }, "stackTrace":{ "type":"string", "maxLength":60, "description":"The stack trace shows where the error occurs during the execution of a program." }, "serverMessage":{ "type":"object", "properties":{ "messageCategory":{ "type":"number", "maximum":0, "minimum":0, "description":"Message Category within Oracle Utilities Application Framework." }, "messageNbr":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework." }, "callSequence":{ "type":"string", "maxLength":60, "description":"Delimited sequence of programs called." }, "programName":{ "type":"string", "maxLength":60, "description":"Name of the program that encountered the error." }, "messageText":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "longDescription":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." } } } } } } }, "W1-UPDSCHWIN_request":{ "type":"object", "properties":{ "W1-UpdSchWin":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"External System" }, "activityId":{ "type":"string", "maxLength":14, "description":"Activity" }, "windowStartDateTime":{ "type":"string", "format":"date-time", "description":"Work Window Start Date/Time" }, "windowEndDateTime":{ "type":"string", "format":"date-time", "description":"Work Window End Date/Time" } } } } }, "W1-UPDSCHWIN_error":{ "type":"object", "properties":{ "problemDetailDocument":{ "type":"object", "properties":{ "problemType":{ "type":"string", "maxLength":60, "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework." }, "title":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "httpStatus":{ "type":"number", "maximum":9999, "minimum":0, "description":"The HTTP Status code for the error." }, "detail":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." }, "problemInstance":{ "type":"string", "maxLength":60, "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction." }, "stackTrace":{ "type":"string", "maxLength":60, "description":"The stack trace shows where the error occurs during the execution of a program." }, "serverMessage":{ "type":"object", "properties":{ "messageCategory":{ "type":"number", "maximum":0, "minimum":0, "description":"Message Category within Oracle Utilities Application Framework." }, "messageNbr":{ "type":"number", "maximum":99999, "minimum":-99999, "description":"Message Number within Oracle Utilities Application Framework." }, "callSequence":{ "type":"string", "maxLength":60, "description":"Delimited sequence of programs called." }, "programName":{ "type":"string", "maxLength":60, "description":"Name of the program that encountered the error." }, "messageText":{ "type":"string", "maxLength":60, "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format." }, "longDescription":{ "type":"string", "maxLength":60, "description":"The long message description from the Oracle Utilities Application Framework in CDATA format." } } } } } } }, "W1-UPDSCHWIN_response":{ "type":"object", "properties":{ "W1-UpdSchWin":{ "type":"object", "properties":{ "externalSystem":{ "type":"string", "maxLength":30, "description":"External System" }, "activityId":{ "type":"string", "maxLength":14, "description":"Activity" }, "windowStartDateTime":{ "type":"string", "format":"date-time", "description":"Work Window Start Date/Time" }, "windowEndDateTime":{ "type":"string", "format":"date-time", "description":"Work Window End Date/Time" } } } } }, "W1-PRJACTDTL_response":{ "type":"object", "properties":{ "W1-PrjActDtl":{ "type":"object", "properties":{ "input":{ "type":"object", "properties":{ "activityId":{ "type":"string", "maxLength":14, "description":"Activity" } } }, "output":{ "type":"object", "properties":{ "activity":{ "type":"object", "properties":{ "activityId":{ "type":"string", "maxLength":14, "description":"Activity" }, "bo":{ "type":"string", "maxLength":30, "description":"Business Object" }, "boStatus":{ "type":"string", "maxLength":12, "description":"Status" }, "activityDetails":{ "type":"object", "properties":{ "workorderdetails":{ "type":"object", "properties":{ "workOrderId":{ "type":"string", "maxLength":14, "description":"Work Order" }, "workOrderNumber":{ "type":"string", "maxLength":14, "description":"Work Order Number" }, "description":{ "type":"string", "maxLength":100, "description":"Description" } } }, "projectDetails":{ "type":"object", "properties":{ "projectId":{ "type":"string", "maxLength":12, "description":"Project" }, "projectNumber":{ "type":"string", "maxLength":14, "description":"Project Number" }, "description":{ "type":"string", "maxLength":100, "description":"Description" }, "externalId":{ "type":"string", "maxLength":60, "description":"External ID" } } }, "activityNumber":{ "type":"number", "maximum":99999, "minimum":0, "description":"Activity Number" }, "info":{ "type":"string", "maxLength":1073741824, "description":"Business Object Data Area" }, "totalPriority":{ "type":"number", "maximum":99, "minimum":0, "description":"Total Risk Priority" }, "requiredByDate":{ "type":"string", "format":"date", "description":"Required By Date" }, "windowStartDateTime":{ "type":"string", "format":"date-time", "description":"Work Window Start Date/Time" }, "windowEndDateTime":{ "type":"string", "format":"date-time", "description":"Work Window End Date/Time" }, "description":{ "type":"string", "maxLength":100, "description":"Description" }, "longDescription":{ "type":"string", "maxLength":4000, "description":"Detailed Description" }, "activityType":{ "type":"string", "maxLength":30, "description":"Activity Type" }, "activityTypeDesc":{ "type":"string", "maxLength":100, "description":"Description" }, "emergency":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Emergency:\n* `W1NO` - No,\n* `W1YS` - Yes" }, "requestor":{ "type":"string", "maxLength":8, "description":"Requestor" }, "requestorInfo":{ "type":"string", "maxLength":1, "description":"Info" }, "craftSummaryInfo":{ "type":"string", "maxLength":1073741824, "description":"Business Object Data Area" }, "equipmentGroup":{ "type":"object", "properties":{ "equipmentList":{ "type":"array", "items":{ "type":"object", "properties":{ "activityResourceRequirementId":{ "type":"string", "maxLength":14, "description":"Activity Resource Requirement" }, "equipment":{ "type":"string", "maxLength":12, "description":"Resource Type" }, "equipmentCode":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "resourceTypeDescription":{ "type":"string", "maxLength":100, "description":"Description" }, "detailedDescription":{ "type":"string", "maxLength":4000, "description":"Detailed Description" }, "uom":{ "type":"string", "maxLength":30, "description":"Resource UOM" }, "quantity":{ "type":"number", "maximum":"99999999.99999", "minimum":0, "description":"Quantity" }, "duration":{ "type":"number", "maximum":"99999999999.99", "minimum":0, "description":"Duration" }, "info":{ "type":"string", "maxLength":1073741824, "description":"Business Object Data Area" } } } } } }, "laborGroup":{ "type":"object", "properties":{ "laborList":{ "type":"array", "items":{ "type":"object", "properties":{ "activityResourceRequirementId":{ "type":"string", "maxLength":14, "description":"Activity Resource Requirement" }, "craft":{ "type":"string", "maxLength":12, "description":"Resource Type" }, "craftCode":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "resourceTypeDescription":{ "type":"string", "maxLength":100, "description":"Description" }, "detailedDescription":{ "type":"string", "maxLength":4000, "description":"Detailed Description" }, "quantity":{ "type":"number", "maximum":"99999999.99999", "minimum":0, "description":"Quantity" }, "duration":{ "type":"number", "maximum":"99999999999.99", "minimum":0, "description":"Duration" }, "info":{ "type":"string", "maxLength":1073741824, "description":"Business Object Data Area" } } } } } }, "otherGroup":{ "type":"object", "properties":{ "otherList":{ "type":"array", "items":{ "type":"object", "properties":{ "activityResourceRequirementId":{ "type":"string", "maxLength":14, "description":"Activity Resource Requirement" }, "resourceTypeDescription":{ "type":"string", "maxLength":100, "description":"Description" }, "other":{ "type":"string", "maxLength":12, "description":"Resource Type" }, "otherResourceCode":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "detailedDescription":{ "type":"string", "maxLength":4000, "description":"Detailed Description" }, "uom":{ "type":"string", "maxLength":30, "description":"Resource UOM" }, "quantity":{ "type":"number", "maximum":"99999999.99999", "minimum":0, "description":"Quantity" }, "info":{ "type":"string", "maxLength":1073741824, "description":"Business Object Data Area" } } } } } }, "storeroomGroup":{ "type":"object", "properties":{ "storeroomList":{ "type":"array", "items":{ "type":"object", "properties":{ "nodeId":{ "type":"string", "maxLength":12, "description":"Location/Organization" }, "storeroomInfo":{ "type":"string", "maxLength":1073741824, "description":"Business Object Data Area" }, "materialGroup":{ "type":"object", "properties":{ "stockItemList":{ "type":"array", "items":{ "type":"object", "properties":{ "activityResourceRequirementId":{ "type":"string", "maxLength":14, "description":"Activity Resource Requirement" }, "stockItemId":{ "type":"string", "maxLength":12, "description":"Resource Type" }, "stockItem":{ "type":"string", "maxLength":60, "description":"Identifier Value" }, "resourceTypeDescription":{ "type":"string", "maxLength":100, "description":"Description" }, "detailedDescription":{ "type":"string", "maxLength":4000, "description":"Detailed Description" }, "uom":{ "type":"string", "maxLength":30, "description":"Resource UOM" }, "quantity":{ "type":"number", "maximum":"99999999.99999", "minimum":0, "description":"Quantity" }, "info":{ "type":"string", "maxLength":1073741824, "description":"Business Object Data Area" } } } } } } } } } } } } } } } } } } } } }, "CREATECOMMUNICATION_response":{ "type":"object", "properties":{ "_self":{ "type":"string", "description":"_self" }, "communicationExternald":{ "type":"string", "maxLength":254, "description":"The external system's unique identifier for the communication log.", "example":"CN189761809" }, "communicationId":{ "type":"string", "maxLength":14, "description":"The system-generated unique identifier for the communication log.", "example":"17796561499666" } }, "xml":{ "name":"W1CreComm" } }, "CREATECOMMUNICATION_request":{ "type":"object", "properties":{ "communicationExternald":{ "type":"string", "maxLength":254, "description":"The external system's unique identifier for the communication log.", "example":"CN189761809" }, "comments":{ "type":"string", "maxLength":4000, "description":"Information from the customer.", "example":"Follow up on the meter read." }, "firstName":{ "type":"string", "maxLength":254, "description":"The first name of the contact person.", "example":"Robert" }, "lastName":{ "type":"string", "maxLength":254, "description":"The last name of the contact person.", "example":"Brown" }, "communicationType":{ "type":"string", "enum":[ "W1CN", "W1EM", "W1PH" ], "description":"Indicates how the communication was received from the customer.\n* `W1CN` - Counter,\n* `W1EM` - Email,\n* `W1PH` - Phone", "example":"W1EM" }, "primaryPhone":{ "type":"string", "maxLength":24, "description":"The primary phone number of the contact person.", "example":"330-532-9834" }, "homePhone":{ "type":"string", "maxLength":24, "description":"The home phone number of the contact person.", "example":"330-532-9834" }, "mobilePhone":{ "type":"string", "maxLength":24, "description":"The mobile phone number of the contact person.", "example":"330-532-9834" }, "originatingEntity":{ "type":"object", "properties":{ "entityType":{ "type":"string", "enum":[ "W1WD", "W1WO", "W1WR" ], "description":"Entity types are the work documents linked to the communication log.\n* `W1WD` - Work Design,\n* `W1WO` - Work Order,\n* `W1WR` - Work Request", "example":"W1WR" }, "entityId":{ "type":"string", "maxLength":254, "description":"The system-generated unique identifier for the entity type.", "example":"20124908366206" } } } }, "xml":{ "name":"W1CreComm" } }, "SEARCHSERVICECALL_response":{ "type":"object", "properties":{ "count":{ "type":"number", "maximum":99999, "minimum":0, "description":"The number of service calls returned by the search.", "example":"1" }, "serviceCalls":{ "type":"array", "items":{ "type":"object", "properties":{ "serviceCallNumber":{ "type":"string", "maxLength":14, "description":"The alternative unique identifier for the service call.", "example":"20220000001209" }, "serviceCall":{ "type":"object", "properties":{ "_link":{ "type":"string", "description":"_link" }, "serviceCallId":{ "type":"string", "maxLength":14, "description":"The system-generated unique identifier for the service call.", "example":"20124908366206" } } }, "serviceCallExternalId":{ "type":"string", "maxLength":60, "description":"The external system's unique identifier for the service call.", "example":"SR202200001" }, "creationDateTime":{ "type":"string", "format":"date-time", "description":"The creation date and time of the service call.", "example":"2022-06-05T10:30:49-07:00" }, "description":{ "type":"string", "maxLength":100, "description":"Short description about the service call.", "example":"New Electric Service" }, "serviceCategory":{ "type":"object", "description":"Service category represents a broad grouping of services provided by the company.", "properties":{ "_link":{ "type":"string", "description":"_link" }, "serviceCategory":{ "type":"string", "maxLength":30, "description":"Service category represents a broad grouping of services provided by the company.", "example":"CM_ElectricService" } } }, "serviceCode":{ "type":"object", "description":"Service code is used to assign actions corresponding to the service call received.", "properties":{ "_link":{ "type":"string", "description":"_link" }, "serviceCode":{ "type":"string", "maxLength":30, "description":"Service code is used to assign actions corresponding to the service call received.", "example":"CM_MeterRead" } } }, "status":{ "type":"string", "maxLength":60, "description":"The current status of the service call.", "example":"Processed" }, "firstName":{ "type":"string", "maxLength":254, "description":"The first name of the contact person.", "example":"Robert" }, "lastName":{ "type":"string", "maxLength":254, "description":"The last name of the contact person.", "example":"Brown" }, "primaryPhone":{ "type":"string", "maxLength":24, "description":"The primary phone number of the contact person.", "example":"330-532-9834" }, "homePhone":{ "type":"string", "maxLength":24, "description":"The home phone number of the contact person.", "example":"330-532-9834" }, "mobilePhone":{ "type":"string", "maxLength":24, "description":"The mobile phone number of the contact person.", "example":"330-532-9834" }, "requiredByDate":{ "type":"string", "format":"date", "description":"The date when the work needs to be completed.", "example":"2022-06-10" }, "callbackRequired":{ "type":"string", "maxLength":4, "description":"Indicates if the customer expects a callback from the utility.", "example":"W1YS" }, "address1":{ "type":"string", "maxLength":254, "description":"The first line of the service call address.", "example":"800 Rosewood Ave" }, "address2":{ "type":"string", "maxLength":254, "description":"The second line of the service call address.", "example":"Suite 101" }, "address3":{ "type":"string", "maxLength":254, "description":"The third line of the service call address." }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line of the service call address." }, "crossStreet":{ "type":"string", "maxLength":64, "description":"The major intersection of the service call address.", "example":"Rosewood and Main" }, "houseType":{ "type":"string", "enum":[ "AP ", "CM " ], "description":"The property type of the service call address.\n* `AP ` - Apartment,\n* `CM ` - Condominium", "example":"AP" }, "number1":{ "type":"string", "maxLength":6, "description":"Address number 1 of the service call address." }, "number2":{ "type":"string", "maxLength":4, "description":"Address number 2 of the service call address." }, "geographicCode":{ "type":"string", "maxLength":11, "description":"The geographic code of the service call address." }, "inCityLimit":{ "type":"boolean", "description":"Indicates if the service call address is within the city boundary." }, "city":{ "type":"string", "maxLength":90, "description":"The city of the service call address.", "example":"North Canton" }, "suburb":{ "type":"string", "maxLength":64, "description":"The suburb of the service call address.", "example":"Peoria Metropolitan" }, "county":{ "type":"string", "maxLength":90, "description":"The county of the service call address.", "example":"Fulton" }, "state":{ "type":"string", "maxLength":6, "description":"The state of the service call address.", "example":"IL" }, "postal":{ "type":"string", "maxLength":12, "description":"The zip code of the service call address.", "example":"61520" }, "country":{ "type":"string", "maxLength":3, "description":"The country of the service call address.", "example":"USA" }, "latitude":{ "type":"number", "maximum":"999999999.999999", "minimum":0, "description":"The latitude coordinate of the service call address.", "example":"40.558270" }, "longitude":{ "type":"number", "maximum":"999999999.999999", "minimum":"-999999999.999999", "description":"The longitude coordinate of the service call address.", "example":"-90.035090" }, "isActive":{ "type":"boolean", "description":"Indicates whether the service call is active or not.", "example":"true" } } } } }, "xml":{ "name":"W1RETSVCCALL" } }, "SEARCHSERVICECALL_request":{ "type":"object", "properties":{ "serviceCallNumber":{ "type":"string", "maxLength":14, "description":"The alternative unique identifier for the service call.", "example":"20220000001209" }, "serviceCallId":{ "type":"string", "maxLength":14, "description":"The system-generated unique identifier for the service call.", "example":"20124908366206" }, "serviceCallExternalId":{ "type":"string", "maxLength":60, "description":"The external system's unique identifier for the service call.", "example":"SR202200001" }, "description":{ "type":"string", "maxLength":100, "description":"Short description about the service call.", "example":"New Electric Service" }, "serviceCategory":{ "type":"string", "maxLength":30, "description":"Service category represents a broad grouping of services provided by the company.", "example":"CM_ElectricService" }, "serviceCode":{ "type":"string", "maxLength":30, "description":"Service code is used to assign actions corresponding to the service call received.", "example":"CM_MeterRead" }, "firstName":{ "type":"string", "maxLength":254, "description":"The first name of the contact person.", "example":"Robert" }, "lastName":{ "type":"string", "maxLength":254, "description":"The last name of the contact person.", "example":"Brown" }, "phoneNumber":{ "type":"string", "maxLength":24, "description":"The phone number (either primary, home or mobile) of the contact person.", "example":"330-532-9834" }, "locations":{ "type":"array", "items":{ "type":"object", "properties":{ "locationId":{ "type":"string", "maxLength":12, "description":"The system-generated unique identifier for the asset location associated to the service call.", "example":"958486684159" }, "locationExternalId":{ "type":"string", "maxLength":60, "description":"The external system's unique identifier for the asset location.", "example":"300000354678942" } } } }, "address":{ "type":"string", "maxLength":254, "description":"The first line of the service call address.", "example":"800 Rosewood Ave" }, "city":{ "type":"string", "maxLength":90, "description":"The city of the service call address.", "example":"North Canton" }, "postal":{ "type":"string", "maxLength":12, "description":"The zip code of the service call address.", "example":"61520" }, "creationFromDateTime":{ "type":"string", "format":"date-time", "description":"The start of the 'creation date time' search filter. Service calls created within the given start and end date times are returned.", "example":"2022-06-01T01:01:07.033Z" }, "creationToDateTime":{ "type":"string", "format":"date-time", "description":"The end of the 'creation date time' search filter. Service calls created within the given start and end date times are returned.", "example":"2022-06-20T20:10:30.652Z" }, "activeOnly":{ "type":"boolean", "description":"Indicates whether to limit the search to active service calls only.", "example":"false" } }, "xml":{ "name":"W1RETSVCCALL" } }, "CANCELSERVICECALL_response":{ "type":"object", "properties":{ "_self":{ "type":"string", "description":"_self" }, "serviceCallId":{ "type":"string", "maxLength":14, "description":"The system-generated unique identifier for the service call.", "example":"20124908366206" }, "communication":{ "type":"object", "properties":{ "_link":{ "type":"string", "description":"_link" }, "communicationId":{ "type":"string", "maxLength":14, "description":"The system-generated unique identifier for the communication log.", "example":"17796561499666" } } }, "communicationExternald":{ "type":"string", "maxLength":254, "description":"The external system's unique identifier for the communication log.", "example":"CN189761809" }, "toDoEntry":{ "type":"object", "properties":{ "_link":{ "type":"string", "description":"_link" }, "toDoEntryId":{ "type":"string", "maxLength":14, "description":"The system-generated unique identifier for the to do.", "example":"34124734366378" } } } }, "xml":{ "name":"W1ReqCanSC" } }, "CREATESERVICECALL_request":{ "type":"object", "properties":{ "serviceCallExternalId":{ "type":"string", "maxLength":60, "description":"The external system's unique identifier for the service call.", "example":"SR202200001" }, "description":{ "type":"string", "maxLength":100, "description":"Short description about the service call.", "example":"New Electric Service" }, "detailedDescription":{ "type":"string", "maxLength":4000, "description":"Additional information about the service call.", "example":"New electric service - customer requesting a meter read" }, "serviceCategory":{ "type":"string", "maxLength":30, "description":"Service category represents a broad grouping of services provided by the company.", "example":"CM_ElectricService" }, "serviceCode":{ "type":"string", "maxLength":30, "description":"Service code is used to assign actions corresponding to the service call received.", "example":"CM_MeterRead" }, "requiredByDate":{ "type":"string", "format":"date", "description":"The date when the work needs to be completed.", "example":"2022-06-10" }, "callbackRequired":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates if the customer expects a callback from the utility.\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"W1YS" }, "locationId":{ "type":"string", "maxLength":12, "description":"The system-generated unique identifier for the asset location associated to the service call.", "example":"958486684159" }, "locationExternalId":{ "type":"string", "maxLength":60, "description":"The external system's unique identifier for the asset location.", "example":"300000354678942" }, "country":{ "type":"string", "maxLength":3, "description":"The country of the service call address.", "example":"USA" }, "address1":{ "type":"string", "maxLength":254, "description":"The first line of the service call address.", "example":"800 Rosewood Ave" }, "address2":{ "type":"string", "maxLength":254, "description":"The second line of the service call address.", "example":"Suite 101" }, "address3":{ "type":"string", "maxLength":254, "description":"The third line of the service call address." }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line of the service call address." }, "crossStreet":{ "type":"string", "maxLength":64, "description":"The major intersection of the service call address.", "example":"Rosewood and Main" }, "houseType":{ "type":"string", "enum":[ "AP ", "CM " ], "description":"The property type of the service call address.\n* `AP ` - Apartment,\n* `CM ` - Condominium", "example":"AP" }, "number1":{ "type":"string", "maxLength":6, "description":"Address number 1 of the service call address." }, "number2":{ "type":"string", "maxLength":4, "description":"Address number 2 of the service call address." }, "geographicCode":{ "type":"string", "maxLength":11, "description":"The geographic code of the service call address." }, "inCityLimit":{ "type":"boolean", "description":"Indicates if the service call address is within the city boundary." }, "city":{ "type":"string", "maxLength":90, "description":"The city of the service call address.", "example":"North Canton" }, "suburb":{ "type":"string", "maxLength":64, "description":"The suburb of the service call address.", "example":"Peoria Metropolitan" }, "county":{ "type":"string", "maxLength":90, "description":"The county of the service call address.", "example":"Fulton" }, "state":{ "type":"string", "maxLength":6, "description":"The state of the service call address.", "example":"IL" }, "postal":{ "type":"string", "maxLength":12, "description":"The zip code of the service call address.", "example":"61520" }, "latitude":{ "type":"number", "maximum":"999999999.999999", "minimum":0, "description":"The latitude coordinate of the service call address.", "example":"40.558270" }, "longitude":{ "type":"number", "maximum":"999999999.999999", "minimum":"-999999999.999999", "description":"The longitude coordinate of the service call address.", "example":"-90.035090" }, "firstName":{ "type":"string", "maxLength":254, "description":"The first name of the contact person.", "example":"Robert" }, "lastName":{ "type":"string", "maxLength":254, "description":"The last name of the contact person.", "example":"Brown" }, "primaryPhone":{ "type":"string", "maxLength":24, "description":"The primary phone number of the contact person.", "example":"330-532-9834" }, "mobilePhone":{ "type":"string", "maxLength":24, "description":"The mobile phone number of the contact person.", "example":"330-532-9834" }, "homePhone":{ "type":"string", "maxLength":24, "description":"The home phone number of the contact person.", "example":"330-532-9834" } }, "xml":{ "name":"W1CreSvcCall" } }, "CANCELSERVICECALL_request":{ "type":"object", "properties":{ "communicationExternald":{ "type":"string", "maxLength":254, "description":"The external system's unique identifier for the communication log.", "example":"CN189761809" }, "comments":{ "type":"string", "maxLength":4000, "description":"Information from the customer.", "example":"Cancel meter read." }, "firstName":{ "type":"string", "maxLength":254, "description":"The first name of the contact person.", "example":"Robert" }, "lastName":{ "type":"string", "maxLength":254, "description":"The last name of the contact person.", "example":"Brown" }, "communicationType":{ "type":"string", "enum":[ "W1CN", "W1EM", "W1PH" ], "description":"Indicates how the communication was received from the customer.\n* `W1CN` - Counter,\n* `W1EM` - Email,\n* `W1PH` - Phone", "example":"Email" }, "primaryPhone":{ "type":"string", "maxLength":24, "description":"The primary phone number of the contact person.", "example":"330-532-9834" }, "homePhone":{ "type":"string", "maxLength":24, "description":"The home phone number of the contact person.", "example":"330-532-9834" }, "mobilePhone":{ "type":"string", "maxLength":24, "description":"The mobile phone number of the contact person.", "example":"330-532-9834" }, "cancelReason":{ "type":"string", "maxLength":4000, "description":"Indicates the reason for the service call cancelation.", "example":"No longer needed." } }, "xml":{ "name":"W1ReqCanSC" } }, "CREATESERVICECALL_response":{ "type":"object", "properties":{ "_self":{ "type":"string", "description":"_self" }, "serviceCallNumber":{ "type":"string", "maxLength":14, "description":"The alternative unique identifier for the service call.", "example":"20220000001209" }, "serviceCallId":{ "type":"string", "maxLength":14, "description":"The system-generated unique identifier for the service call.", "example":"20124908366206" }, "serviceCallExternalId":{ "type":"string", "maxLength":60, "description":"The external system's unique identifier for the service call.", "example":"SR202200001" } }, "xml":{ "name":"W1CreSvcCall" } }, "GETSERVICECALL_response":{ "type":"object", "properties":{ "creationDateTime":{ "type":"string", "format":"date-time", "description":"The creation date and time of the service call.", "example":"2022-06-05T10:30:49-07:00" }, "serviceCallId":{ "type":"string", "maxLength":14, "description":"The system-generated unique identifier for the service call.", "example":"20124908366206" }, "serviceCallExternalId":{ "type":"string", "maxLength":60, "description":"The external system's unique identifier for the asset location.", "example":"300000354678942" }, "serviceCallNumber":{ "type":"string", "maxLength":14, "description":"The alternative unique identifier for the service call.", "example":"20220000001209" }, "description":{ "type":"string", "maxLength":100, "description":"Short description about the service call.", "example":"New Electric Service" }, "detailedDescription":{ "type":"string", "maxLength":4000, "description":"Additional information about the service call.", "example":"New electric service - customer requesting a meter read" }, "serviceCategory":{ "type":"object", "description":"Service category represents a broad grouping of services provided by the company.", "properties":{ "_link":{ "type":"string", "description":"_link" }, "serviceCategory":{ "type":"string", "maxLength":30, "description":"Service category represents a broad grouping of services provided by the company.", "example":"CM_ElectricService" } } }, "serviceCode":{ "type":"object", "description":"Service code is used to assign actions corresponding to the service call received.", "properties":{ "_link":{ "type":"string", "description":"_link" }, "serviceCode":{ "type":"string", "maxLength":30, "description":"Service code is used to assign actions corresponding to the service call received.", "example":"CM_MeterRead" } } }, "requiredByDate":{ "type":"string", "format":"date", "description":"The date when the work needs to be completed.", "example":"2022-06-10" }, "status":{ "type":"string", "maxLength":60, "description":"The current status of the service call.", "example":"Processed" }, "callbackRequired":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates if the customer expects a callback from the utility.\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"W1YS" }, "callbackCompleted":{ "type":"string", "enum":[ "W1NO", "W1YS" ], "description":"Indicates if the utility has called the customer back.\n* `W1NO` - No,\n* `W1YS` - Yes", "example":"W1NO" }, "location":{ "type":"object", "properties":{ "_link":{ "type":"string", "description":"_link" }, "locationId":{ "type":"string", "maxLength":12, "description":"Location/Organization" } } }, "address1":{ "type":"string", "maxLength":254, "description":"The first line of the service call address.", "example":"800 Rosewood Ave" }, "address2":{ "type":"string", "maxLength":254, "description":"The second line of the service call address.", "example":"Suite 101" }, "address3":{ "type":"string", "maxLength":254, "description":"The third line of the service call address." }, "address4":{ "type":"string", "maxLength":254, "description":"The fourth line of the service call address." }, "crossStreet":{ "type":"string", "maxLength":64, "description":"The major intersection of the service call address.", "example":"Rosewood and Main" }, "houseType":{ "type":"string", "enum":[ "AP ", "CM " ], "description":"The property type of the service call address.\n* `AP ` - Apartment,\n* `CM ` - Condominium", "example":"AP" }, "number1":{ "type":"string", "maxLength":6, "description":"Address number 1 of the service call address." }, "number2":{ "type":"string", "maxLength":4, "description":"Address number 2 of the service call address." }, "geographicCode":{ "type":"string", "maxLength":11, "description":"The geographic code of the service call address." }, "inCityLimit":{ "type":"boolean", "description":"Indicates if the service call address is within the city boundary." }, "city":{ "type":"string", "maxLength":90, "description":"The city of the service call address.", "example":"North Canton" }, "suburb":{ "type":"string", "maxLength":64, "description":"The suburb of the service call address.", "example":"Peoria Metropolitan" }, "county":{ "type":"string", "maxLength":90, "description":"The county of the service call address.", "example":"Fulton" }, "state":{ "type":"string", "maxLength":6, "description":"The state of the service call address.", "example":"IL" }, "postal":{ "type":"string", "maxLength":12, "description":"The zip code of the service call address.", "example":"61520" }, "country":{ "type":"string", "maxLength":3, "description":"The country of the service call address.", "example":"USA" }, "latitude":{ "type":"number", "maximum":"999999999.999999", "minimum":0, "description":"The latitude coordinate of the service call address.", "example":"40.558270" }, "longitude":{ "type":"number", "maximum":"999999999.999999", "minimum":"-999999999.999999", "description":"The longitude coordinate of the service call address.", "example":"-90.035090" }, "firstName":{ "type":"string", "maxLength":254, "description":"The first name of the contact person.", "example":"Robert" }, "lastName":{ "type":"string", "maxLength":254, "description":"The last name of the contact person.", "example":"Brown" }, "primaryPhone":{ "type":"string", "maxLength":24, "description":"The primary phone number of the contact person.", "example":"330-532-9834" }, "homePhone":{ "type":"string", "maxLength":24, "description":"The home phone number of the contact person.", "example":"330-532-9834" }, "mobilePhone":{ "type":"string", "maxLength":24, "description":"The mobile phone number of the contact person.", "example":"330-532-9834" }, "info":{ "type":"string", "maxLength":1000, "description":"Contains relevant information about the service call.", "example":"20220000001209, New Electric Service, Created By: External System, Processed" }, "communicationlogs":{ "type":"array", "items":{ "type":"object", "properties":{ "communication":{ "type":"object", "properties":{ "_link":{ "type":"string", "description":"_link" }, "communicationId":{ "type":"string", "maxLength":14, "description":"The system-generated unique identifier for the communication log.", "example":"17796561499666" } } }, "communicationExternald":{ "type":"string", "maxLength":254, "description":"The external system's unique identifier for the communication log.", "example":"CN189761809" }, "communicationType":{ "type":"string", "enum":[ "W1CN", "W1EM", "W1PH" ], "description":"Indicates how the communication was received from the customer.\n* `W1CN` - Counter,\n* `W1EM` - Email,\n* `W1PH` - Phone", "example":"Email" }, "comments":{ "type":"string", "maxLength":4000, "description":"Information from the customer.", "example":"Follow up on the meter read." }, "response":{ "type":"string", "maxLength":4000, "description":"Response from the utility.", "example":"Meter read scheduled on Friday between 9-11 am." }, "creationDateTime":{ "type":"string", "format":"date-time", "description":"The creation date and time of the communication log.", "example":"2022-06-09T12:35:44-07:00" }, "firstName":{ "type":"string", "maxLength":254, "description":"The first name of the contact person.", "example":"Robert" }, "lastName":{ "type":"string", "maxLength":254, "description":"The last name of the contact person.", "example":"Brown" }, "primaryPhone":{ "type":"string", "maxLength":24, "description":"The primary phone number of the contact person.", "example":"330-532-9834" }, "homePhone":{ "type":"string", "maxLength":24, "description":"The home phone number of the contact person.", "example":"330-532-9834" }, "mobilePhone":{ "type":"string", "maxLength":24, "description":"The mobile phone number of the contact person.", "example":"330-532-9834" }, "info":{ "type":"string", "maxLength":1000, "description":"Contains relevant information about the communication log.", "example":"06-03-2022 05:20PM, Email, Brown, Robert, Primary Phone: 330-532-9834" } } } } }, "xml":{ "name":"W1GetSCDtls" } }, "GETSERVICECALLENTITIES_response":{ "type":"object", "properties":{ "entityType":{ "type":"string", "enum":[ "W1WA", "W1WD", "W1WO", "W1WR" ], "description":"This entity type can either be the service call or another work document created from the service call.\n* `W1WA` - Work Activity,\n* `W1WD` - Work Design,\n* `W1WO` - Work Order,\n* `W1WR` - Work Request", "example":"W1WR" }, "entityId":{ "type":"string", "maxLength":254, "description":"The system-generated unique identifier for the entity type.", "example":"24797648086753" }, "info":{ "type":"string", "maxLength":1000, "description":"Contains relevant information about the service call or another work document created from the service call.", "example":"20220000001209, New Electric Service, Created By: External System, Processed" }, "communicationlogs":{ "type":"array", "items":{ "type":"object", "properties":{ "communication":{ "type":"object", "properties":{ "_link":{ "type":"string", "description":"_link" }, "communicationId":{ "type":"string", "maxLength":14, "description":"The system-generated unique identifier for the communication log.", "example":"17796561499666" } } }, "info":{ "type":"string", "maxLength":1000, "description":"Contains relevant information about the communication log.", "example":"06-03-2022 05:20PM, Email, Brown, Robert, Primary Phone: 330-532-9834" } } } }, "relatedDocuments":{ "type":"array", "items":{ "type":"object", "properties":{ "entityType":{ "type":"string", "enum":[ "W1WA", "W1WD", "W1WO", "W1WR" ], "description":"Work documents created from the service call.\n* `W1WA` - Work Activity,\n* `W1WD` - Work Design,\n* `W1WO` - Work Order,\n* `W1WR` - Work Request", "example":"W1WO" }, "info":{ "type":"string", "maxLength":1000, "description":"Contains relevant information about the work document.", "example":"Work Order: 20220000000213, Approved, Meter Read, 1 Activity" }, "entity":{ "type":"object", "properties":{ "entityId":{ "type":"string", "maxLength":254, "description":"The system-generated unique identifier for the entity type.", "example":"24797648086753" }, "_link":{ "type":"string", "maxLength":256, "description":"Anchor Link" } } } } } } }, "xml":{ "name":"W1RetRelObj" } } } }, "security":[ { "BasicAuth":[ ] } ] }