1. Oracle Utilities REST API for Work and Asset
  2. Tasks
  3. Purchasing
  4. Blanket Contract

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
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : input
Type: object
Show Source
  • blanketContract
  • 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
  • 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 : output
Type: object
Show Source
Nested Schema : blanketContract
Type: object
Show Source
Nested Schema : header
Type: object
Show Source
  • 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
  • Maximum Length: 60
    Identifier Value
  • Maximum Length: 14
    Unique number for the Blanket Contract.
    Example: 52315
  • Date and Time when the Blanket Contract was initiated.
    Example: 2021-10-13T13:05:51.000+00:00
  • Maximum Length: 3
    Currency Code.
    Example: USD
  • Maximum Length: 100
    Brief description of the Blanket Contract.
    Example: Blanket Contract Rev 3
  • The expiration date indicates the date by which the contract must be renegotiated.
    Example: 2021-12-31
  • Maximum Length: 30
    Free on board code. This field is controlled by the Free on Board portal.
    Example: WD-DestFreightPrepaid
  • The initiation date is the first date the blanket contract can be used.
    Example: 2021-10-13
  • Minimum Value: -999999999999.999
    Maximum Value: 999999999999.999
    The dollar value limit for the contract.
    Example: 10000
  • Maximum Length: 30
    Blanket Contract Payment Terms.
    Example: CM-Pay30Days
  • Minimum Value: -999
    Maximum Value: 999
    The revision number of the Blanket Contract.
    Example: 1
  • 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
  • Maximum Length: 60
    External ID
Nested Schema : lines
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : requisitionInfo
Type: object
Show Source
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : input
Type: object
Show Source
  • blanketContract
  • 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
  • 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 : output
Type: object
Show Source
Nested Schema : blanketContract
Type: object
Show Source
Nested Schema : header
Type: object
Show Source
  • 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
  • Maximum Length: 60
    Identifier Value
  • Maximum Length: 14
    Unique number for the Blanket Contract.
    Example: 52315
  • Date and Time when the Blanket Contract was initiated.
    Example: 2021-10-13T13:05:51.000+00:00
  • Maximum Length: 3
    Currency Code.
    Example: USD
  • Maximum Length: 100
    Brief description of the Blanket Contract.
    Example: Blanket Contract Rev 3
  • The expiration date indicates the date by which the contract must be renegotiated.
    Example: 2021-12-31
  • Maximum Length: 30
    Free on board code. This field is controlled by the Free on Board portal.
    Example: WD-DestFreightPrepaid
  • The initiation date is the first date the blanket contract can be used.
    Example: 2021-10-13
  • Minimum Value: -999999999999.999
    Maximum Value: 999999999999.999
    The dollar value limit for the contract.
    Example: 10000
  • Maximum Length: 30
    Blanket Contract Payment Terms.
    Example: CM-Pay30Days
  • Minimum Value: -999
    Maximum Value: 999
    The revision number of the Blanket Contract.
    Example: 1
  • 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
  • Maximum Length: 60
    External ID
Nested Schema : lines
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : requisitionInfo
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Success response
Body ()
Root Schema : SYNCBLANKETCONTRACT_response
Type: object
Show Source
Nested Schema : W1BlnktSyn
Type: object
Show Source
Nested Schema : input
Type: object
Show Source
  • blanketContract
  • 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
  • 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 : output
Type: object
Show Source
Nested Schema : blanketContract
Type: object
Show Source
Nested Schema : header
Type: object
Show Source
  • 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
  • Maximum Length: 60
    Identifier Value
  • Maximum Length: 14
    Unique number for the Blanket Contract.
    Example: 52315
  • Date and Time when the Blanket Contract was initiated.
    Example: 2021-10-13T13:05:51.000+00:00
  • Maximum Length: 3
    Currency Code.
    Example: USD
  • Maximum Length: 100
    Brief description of the Blanket Contract.
    Example: Blanket Contract Rev 3
  • The expiration date indicates the date by which the contract must be renegotiated.
    Example: 2021-12-31
  • Maximum Length: 30
    Free on board code. This field is controlled by the Free on Board portal.
    Example: WD-DestFreightPrepaid
  • The initiation date is the first date the blanket contract can be used.
    Example: 2021-10-13
  • Minimum Value: -999999999999.999
    Maximum Value: 999999999999.999
    The dollar value limit for the contract.
    Example: 10000
  • Maximum Length: 30
    Blanket Contract Payment Terms.
    Example: CM-Pay30Days
  • Minimum Value: -999
    Maximum Value: 999
    The revision number of the Blanket Contract.
    Example: 1
  • 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
  • Maximum Length: 60
    External ID
Nested Schema : lines
Type: object
Show Source
Nested Schema : _data
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : requisitionInfo
Type: object
Show Source

400 Response

Bad Request
Body ()
Root Schema : SYNCBLANKETCONTRACT_error
Type: object
Show Source
Nested Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.

500 Response

Internal Server Error
Body ()
Root Schema : SYNCBLANKETCONTRACT_error
Type: object
Show Source
Nested Schema : problemDetailDocument
Type: object
Show Source
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 9999
    The HTTP Status code for the error.
  • 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.
  • 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
  • Maximum Length: 60
    The stack trace shows where the error occurs during the execution of a program.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
Nested Schema : serverMessage
Type: object
Show Source
  • Maximum Length: 60
    Delimited sequence of programs called.
  • Maximum Length: 60
    The long message description from the Oracle Utilities Application Framework in CDATA format.
  • Minimum Value: 0
    Maximum Value: 0
    Message Category within Oracle Utilities Application Framework.
  • Minimum Value: -99999
    Maximum Value: 99999
    Message Number within Oracle Utilities Application Framework.
  • Maximum Length: 60
    Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
  • Maximum Length: 60
    Name of the program that encountered the error.
Back to Top