Synchronize Blanket Contract
post
https://server:port/rest/apis/asset/purchasing/blanketContractSynchronization/
This REST service synchronizes Enterprise Resource Planning Blanket Contracts with Work and Asset Management.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Nested Schema : input
Type:
Show Source
object
-
blanketContract: object
blanketContract
-
externalReferenceId: string
Maximum Length:
36
Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000230554500
-
externalSystem: string
Maximum Length:
30
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
Nested Schema : header
Type:
Show Source
object
-
blanketCategory: string
Allowed Values:
[ "ZZBP", "ZZCP" ]
The category field provides information indicating the type of contract such as whether it is for goods or services. * `ZZBP` - Blanket Purchase Agreement (BPA), * `ZZCP` - Contract Purchase Agreement (CPA)Example:BPA
-
blanketContractHeaderExternalId: string
Maximum Length:
60
Identifier Value -
blanketContractNumber: string
Maximum Length:
14
Unique number for the Blanket Contract.Example:52315
-
creationDateTime: string
(date-time)
Date and Time when the Blanket Contract was initiated.Example:
2021-10-13T13:05:51.000+00:00
-
currency: string
Maximum Length:
3
Currency Code.Example:USD
-
description: string
Maximum Length:
100
Brief description of the Blanket Contract.Example:Blanket Contract Rev 3
-
expirationDate: string
(date)
The expiration date indicates the date by which the contract must be renegotiated.Example:
2021-12-31
-
fob: string
Maximum Length:
30
Free on board code. This field is controlled by the Free on Board portal.Example:WD-DestFreightPrepaid
-
initiationDate: string
(date)
The initiation date is the first date the blanket contract can be used.Example:
2021-10-13
-
limitAmount: number
Minimum Value:
-9.99999999999999E11
Maximum Value:9.99999999999999E11
The dollar value limit for the contract.Example:10000
-
paymentTerms: string
Maximum Length:
30
Blanket Contract Payment Terms.Example:CM-Pay30Days
-
revisionNumber: number
Minimum Value:
-999
Maximum Value:999
The revision number of the Blanket Contract.Example:1
-
status: string
Maximum Length:
12
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
-
vendorLocationExternalId: string
Maximum Length:
60
External ID
Nested Schema : items
Type:
Show Source
object
-
allowOnPo: string
Allowed Values:
[ "W1AL", "W1NA" ]
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. * `W1AL` - Yes, * `W1NA` - NoExample:W1AL
-
blanketContractLineExternalId: string
Maximum Length:
60
Identifier Value -
creationDateTime: string
(date-time)
Date and Time when the Blanket Contract was initiated.Example:
2021-10-13T13:05:51.000+00:00
-
description: string
Maximum Length:
100
Brief description of the Blanket Contract.Example:Blanket Contract Rev 3
-
lineNumber: number
Minimum Value:
0
Maximum Value:999
Blanket Contract Line NumberExample:1
-
requisitionInfo: object
requisitionInfo
-
resourceTypeExternalId: string
Maximum Length:
60
External ID
Nested Schema : requisitionInfo
Type:
Show Source
object
-
purchaseToIssueRatio: number
Minimum Value:
0
Maximum Value:99999999
PI RatioExample:1
-
unitOfPurchase: string
Maximum Length:
30
Blanket Contract Unit of Purchase.Example:WD-Each
-
unitPrice: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
Blanket Contract Unit Price.Example:$100
Nested Schema : input
Type:
Show Source
object
-
blanketContract: object
blanketContract
-
externalReferenceId: string
Maximum Length:
36
Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000230554500
-
externalSystem: string
Maximum Length:
30
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
Nested Schema : header
Type:
Show Source
object
-
blanketCategory: string
Allowed Values:
[ "ZZBP", "ZZCP" ]
The category field provides information indicating the type of contract such as whether it is for goods or services. * `ZZBP` - Blanket Purchase Agreement (BPA), * `ZZCP` - Contract Purchase Agreement (CPA)Example:BPA
-
blanketContractHeaderExternalId: string
Maximum Length:
60
Identifier Value -
blanketContractNumber: string
Maximum Length:
14
Unique number for the Blanket Contract.Example:52315
-
creationDateTime: string
(date-time)
Date and Time when the Blanket Contract was initiated.Example:
2021-10-13T13:05:51.000+00:00
-
currency: string
Maximum Length:
3
Currency Code.Example:USD
-
description: string
Maximum Length:
100
Brief description of the Blanket Contract.Example:Blanket Contract Rev 3
-
expirationDate: string
(date)
The expiration date indicates the date by which the contract must be renegotiated.Example:
2021-12-31
-
fob: string
Maximum Length:
30
Free on board code. This field is controlled by the Free on Board portal.Example:WD-DestFreightPrepaid
-
initiationDate: string
(date)
The initiation date is the first date the blanket contract can be used.Example:
2021-10-13
-
limitAmount: number
Minimum Value:
-9.99999999999999E11
Maximum Value:9.99999999999999E11
The dollar value limit for the contract.Example:10000
-
paymentTerms: string
Maximum Length:
30
Blanket Contract Payment Terms.Example:CM-Pay30Days
-
revisionNumber: number
Minimum Value:
-999
Maximum Value:999
The revision number of the Blanket Contract.Example:1
-
status: string
Maximum Length:
12
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
-
vendorLocationExternalId: string
Maximum Length:
60
External ID
Nested Schema : items
Type:
Show Source
object
-
allowOnPo: string
Allowed Values:
[ "W1AL", "W1NA" ]
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. * `W1AL` - Yes, * `W1NA` - NoExample:W1AL
-
blanketContractLineExternalId: string
Maximum Length:
60
Identifier Value -
creationDateTime: string
(date-time)
Date and Time when the Blanket Contract was initiated.Example:
2021-10-13T13:05:51.000+00:00
-
description: string
Maximum Length:
100
Brief description of the Blanket Contract.Example:Blanket Contract Rev 3
-
lineNumber: number
Minimum Value:
0
Maximum Value:999
Blanket Contract Line NumberExample:1
-
requisitionInfo: object
requisitionInfo
-
resourceTypeExternalId: string
Maximum Length:
60
External ID
Nested Schema : requisitionInfo
Type:
Show Source
object
-
purchaseToIssueRatio: number
Minimum Value:
0
Maximum Value:99999999
PI RatioExample:1
-
unitOfPurchase: string
Maximum Length:
30
Blanket Contract Unit of Purchase.Example:WD-Each
-
unitPrice: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
Blanket Contract Unit Price.Example:$100
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Nested Schema : input
Type:
Show Source
object
-
blanketContract: object
blanketContract
-
externalReferenceId: string
Maximum Length:
36
Represents Enterprise Resource Planning's unique system-generated item ID. Work and Asset Management's externalReferenceId and resourceTypeExternalId use the same value.Example:300000230554500
-
externalSystem: string
Maximum Length:
30
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
Nested Schema : header
Type:
Show Source
object
-
blanketCategory: string
Allowed Values:
[ "ZZBP", "ZZCP" ]
The category field provides information indicating the type of contract such as whether it is for goods or services. * `ZZBP` - Blanket Purchase Agreement (BPA), * `ZZCP` - Contract Purchase Agreement (CPA)Example:BPA
-
blanketContractHeaderExternalId: string
Maximum Length:
60
Identifier Value -
blanketContractNumber: string
Maximum Length:
14
Unique number for the Blanket Contract.Example:52315
-
creationDateTime: string
(date-time)
Date and Time when the Blanket Contract was initiated.Example:
2021-10-13T13:05:51.000+00:00
-
currency: string
Maximum Length:
3
Currency Code.Example:USD
-
description: string
Maximum Length:
100
Brief description of the Blanket Contract.Example:Blanket Contract Rev 3
-
expirationDate: string
(date)
The expiration date indicates the date by which the contract must be renegotiated.Example:
2021-12-31
-
fob: string
Maximum Length:
30
Free on board code. This field is controlled by the Free on Board portal.Example:WD-DestFreightPrepaid
-
initiationDate: string
(date)
The initiation date is the first date the blanket contract can be used.Example:
2021-10-13
-
limitAmount: number
Minimum Value:
-9.99999999999999E11
Maximum Value:9.99999999999999E11
The dollar value limit for the contract.Example:10000
-
paymentTerms: string
Maximum Length:
30
Blanket Contract Payment Terms.Example:CM-Pay30Days
-
revisionNumber: number
Minimum Value:
-999
Maximum Value:999
The revision number of the Blanket Contract.Example:1
-
status: string
Maximum Length:
12
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
-
vendorLocationExternalId: string
Maximum Length:
60
External ID
Nested Schema : items
Type:
Show Source
object
-
allowOnPo: string
Allowed Values:
[ "W1AL", "W1NA" ]
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. * `W1AL` - Yes, * `W1NA` - NoExample:W1AL
-
blanketContractLineExternalId: string
Maximum Length:
60
Identifier Value -
creationDateTime: string
(date-time)
Date and Time when the Blanket Contract was initiated.Example:
2021-10-13T13:05:51.000+00:00
-
description: string
Maximum Length:
100
Brief description of the Blanket Contract.Example:Blanket Contract Rev 3
-
lineNumber: number
Minimum Value:
0
Maximum Value:999
Blanket Contract Line NumberExample:1
-
requisitionInfo: object
requisitionInfo
-
resourceTypeExternalId: string
Maximum Length:
60
External ID
Nested Schema : requisitionInfo
Type:
Show Source
object
-
purchaseToIssueRatio: number
Minimum Value:
0
Maximum Value:99999999
PI RatioExample:1
-
unitOfPurchase: string
Maximum Length:
30
Blanket Contract Unit of Purchase.Example:WD-Each
-
unitPrice: number
Minimum Value:
-1.0E11
Maximum Value:1.0E11
Blanket Contract Unit Price.Example:$100
400 Response
Bad Request
Nested Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
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. -
problemType: string
Maximum Length:
60
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. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.
500 Response
Internal Server Error
Nested Schema : problemDetailDocument
Type:
Show Source
object
-
detail: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
httpStatus: number
Minimum Value:
0
Maximum Value:9999
The HTTP Status code for the error. -
problemInstance: string
Maximum Length:
60
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. -
problemType: string
Maximum Length:
60
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. -
serverMessage: object
serverMessage
-
stackTrace: string
Maximum Length:
60
The stack trace shows where the error occurs during the execution of a program. -
title: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type:
Show Source
object
-
callSequence: string
Maximum Length:
60
Delimited sequence of programs called. -
longDescription: string
Maximum Length:
60
The long message description from the Oracle Utilities Application Framework in CDATA format. -
messageCategory: number
Minimum Value:
0
Maximum Value:0
Message Category within Oracle Utilities Application Framework. -
messageNbr: number
Minimum Value:
-99999
Maximum Value:99999
Message Number within Oracle Utilities Application Framework. -
messageText: string
Maximum Length:
60
Fully qualified error message from Oracle Utilities Application Framework in CDATA format. -
programName: string
Maximum Length:
60
Name of the program that encountered the error.