1. REST API for Oracle Procurement Cloud
  2. Tasks
  3. Content Zones

Update one content zone

patch

/fscmRestApi/resources/11.13.18.05/contentZones/{contentZonesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Content Zones resource and used to uniquely identify an instance of Content Zones. The client should not generate the hash key value. Instead, the client should query on the Content Zones collection resource in order to navigate to a specific instance of Content Zones to get the hash key.
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Catalog Assignments
    Title: Catalog Assignments
    The Catalog Assignments resource manages the catalog assignments for a content zone. Local, Punchout, and Informational catalog types can be assigned to a content zone.
  • Title: Content Zone
    Maximum Length: 30
    Name of the content zone.
  • Title: Description
    Maximum Length: 240
    Description of the content zone.
  • Public Shopping List Assignments
    Title: Public Shopping List Assignments
    The Public Shopping List Assignments resource manages the public shopping list assignments for a content zone.
  • Title: Secured By
    Security value to determine how content zones are secured. Valid values are All requisitioning BUs, Requisitioning BUs, Workers, All procurement agents, and Deliver-to locations.
  • Maximum Length: 18
    Abbreviation that identifies whether a content zone is secured by all requisitioning BUs, specific requisitioning BUs, specific workers, all procurement agents, or specific deliver-to locations. Valid values are AVAIL_ALL_REQ_BUS, SECURED_BY_BU, SECURED_BY_WORKER, AVAIL_ALL_WORKERS, and SECURED_BY_DEL_LOC.
  • Security Assignments
    Title: Security Assignments
    The Security Assignments resource manages the security access assignments for the content zones by requisitioning BUs, workers, or deliver-to locations.
  • Smart Form Assignments
    Title: Smart Form Assignments
    The Smart Form Assignments resource manages the smart form assignments for a content zone. Smart forms can be assigned to a content zone only for requisitioning usage.
  • Title: Usage
    Usage to determine where the content zone will be applied. Valid values are Requisitioning or Procurement.
  • Maximum Length: 15
    Abbreviation that identifies whether the content zone is used for requisitioning or procurement. Valid values are REQUISITIONING or PROCUREMENT.
Nested Schema : Catalog Assignments
Type: array
Title: Catalog Assignments
The Catalog Assignments resource manages the catalog assignments for a content zone. Local, Punchout, and Informational catalog types can be assigned to a content zone.
Show Source
Nested Schema : Public Shopping List Assignments
Type: array
Title: Public Shopping List Assignments
The Public Shopping List Assignments resource manages the public shopping list assignments for a content zone.
Show Source
Nested Schema : Security Assignments
Type: array
Title: Security Assignments
The Security Assignments resource manages the security access assignments for the content zones by requisitioning BUs, workers, or deliver-to locations.
Show Source
Nested Schema : Smart Form Assignments
Type: array
Title: Smart Form Assignments
The Smart Form Assignments resource manages the smart form assignments for a content zone. Smart forms can be assigned to a content zone only for requisitioning usage.
Show Source
Nested Schema : contentZones-catalogAssignments-item-patch-request
Type: object
Show Source
  • Title: Catalog
    Name of the catalog that's assigned to the content zone.
Nested Schema : contentZones-publicShoppingListAssignments-item-patch-request
Type: object
Show Source
Nested Schema : contentZones-securityAssignments-item-patch-request
Type: object
Show Source
Nested Schema : contentZones-smartFormAssignments-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : contentZones-item-response
Type: object
Show Source
  • Catalog Assignments
    Title: Catalog Assignments
    The Catalog Assignments resource manages the catalog assignments for a content zone. Local, Punchout, and Informational catalog types can be assigned to a content zone.
  • Title: Content Zone
    Maximum Length: 30
    Name of the content zone.
  • Read Only: true
    Value that uniquely identifies the content zone.
  • Read Only: true
    Maximum Length: 64
    User who created the content zone.
  • Read Only: true
    Date and time when the user created the content zone.
  • Title: Description
    Maximum Length: 240
    Description of the content zone.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the content zone.
  • Read Only: true
    Date and time when the user most recently updated the content zone.
  • Links
  • Title: Procurement BU
    Name of the procurement business unit in which the content zone is created.
  • Value that uniquely identifies the procurement business unit in which the content zone is created.
  • Public Shopping List Assignments
    Title: Public Shopping List Assignments
    The Public Shopping List Assignments resource manages the public shopping list assignments for a content zone.
  • Title: Secured By
    Security value to determine how content zones are secured. Valid values are All requisitioning BUs, Requisitioning BUs, Workers, All procurement agents, and Deliver-to locations.
  • Maximum Length: 18
    Abbreviation that identifies whether a content zone is secured by all requisitioning BUs, specific requisitioning BUs, specific workers, all procurement agents, or specific deliver-to locations. Valid values are AVAIL_ALL_REQ_BUS, SECURED_BY_BU, SECURED_BY_WORKER, AVAIL_ALL_WORKERS, and SECURED_BY_DEL_LOC.
  • Security Assignments
    Title: Security Assignments
    The Security Assignments resource manages the security access assignments for the content zones by requisitioning BUs, workers, or deliver-to locations.
  • Smart Form Assignments
    Title: Smart Form Assignments
    The Smart Form Assignments resource manages the smart form assignments for a content zone. Smart forms can be assigned to a content zone only for requisitioning usage.
  • Title: Usage
    Usage to determine where the content zone will be applied. Valid values are Requisitioning or Procurement.
  • Maximum Length: 15
    Abbreviation that identifies whether the content zone is used for requisitioning or procurement. Valid values are REQUISITIONING or PROCUREMENT.
Nested Schema : Catalog Assignments
Type: array
Title: Catalog Assignments
The Catalog Assignments resource manages the catalog assignments for a content zone. Local, Punchout, and Informational catalog types can be assigned to a content zone.
Show Source
Nested Schema : Public Shopping List Assignments
Type: array
Title: Public Shopping List Assignments
The Public Shopping List Assignments resource manages the public shopping list assignments for a content zone.
Show Source
Nested Schema : Security Assignments
Type: array
Title: Security Assignments
The Security Assignments resource manages the security access assignments for the content zones by requisitioning BUs, workers, or deliver-to locations.
Show Source
Nested Schema : Smart Form Assignments
Type: array
Title: Smart Form Assignments
The Smart Form Assignments resource manages the smart form assignments for a content zone. Smart forms can be assigned to a content zone only for requisitioning usage.
Show Source
Nested Schema : contentZones-catalogAssignments-item-response
Type: object
Show Source
Nested Schema : contentZones-publicShoppingListAssignments-item-response
Type: object
Show Source
Nested Schema : contentZones-securityAssignments-item-response
Type: object
Show Source
Nested Schema : contentZones-smartFormAssignments-item-response
Type: object
Show Source
Links
catalogAssignments
Parameters:
  • contentZonesUniqID: $request.path.contentZonesUniqID
The Catalog Assignments resource manages the catalog assignments for a content zone. Local, Punchout, and Informational catalog types can be assigned to a content zone.
publicShoppingListAssignments
Parameters:
  • contentZonesUniqID: $request.path.contentZonesUniqID
The Public Shopping List Assignments resource manages the public shopping list assignments for a content zone.
securityAssignments
Parameters:
  • contentZonesUniqID: $request.path.contentZonesUniqID
The Security Assignments resource manages the security access assignments for the content zones by requisitioning BUs, workers, or deliver-to locations.
smartFormAssignments
Parameters:
  • contentZonesUniqID: $request.path.contentZonesUniqID
The Smart Form Assignments resource manages the smart form assignments for a content zone. Smart forms can be assigned to a content zone only for requisitioning usage.
Back to Top

Examples

This example describes how to update one content zone. You can update ContentZone, Description, Usage, and SecuredBy of a content zone.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/contentZones/contentZonesUniqID"
For example:

                  
                  
               

               
               
               

                  
Example Request Body

                  
                  
                  
The following example includes the contents of the request
                body in JSON format. You replace the request
                    payload in the cURL command with the contents of the Example Request Body.
                The request payload specifies attribute values that the command will use in the
                record that it updates.
                  

                  
                  

                     

                        
Note:

                     
If the content zone already contains security assignments, then you must
                delete them first before updating the SecuredBy attribute. For example, to change
                the SecuredBy Requisitioning BUs to All requisitioning BUs, you must first delete
                the requisitioning BU assignments. Similarly, you must first delete Informational
                catalogs, Punchout catalogs, and smart form assignments when updating the usage to
                Procurement from Requisitioning.
                  

                  
{
    "ContentZone": "Office Cafeteria Supplies",
    "Description": "This content zone is for requisitioning and secured by all requisitioning BUs",
    "SecuredBy": "All requisitioning BUs"
}

                  

               
               
               

                  
Example Response Body

                  
                  
                  
The following example includes the contents of the response
                body in JSON format:
{
    "ContentZoneId": 300100585360628,
    "ContentZone": "Office Cafeteria Supplies",
    "ProcurementBUId": 1017,
    "ProcurementBU": "Vision Italy",
    "Description": "This content zone is for requisitioning and secured by all requisitioning BUs",
    "UsageCode": "REQUISITIONING",
    "Usage": "Requisitioning",
    "SecuredByCode": "AVAIL_ALL_REQ_BUS",
    "SecuredBy": "All requisitioning BUs",
    "CreationDate": "2023-11-02T08:23:03+00:00",
    "CreatedBy": "CVBUYER01",
    "LastUpdatedBy": "CVBUYER01",
    "LastUpdatedDate": "2023-11-02T08:23:03.001+00:00",
    "links": [
        . . .
    ]
}

                  
               

               
               
            

            
         
                 Back to Top