1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Supply Chain Planning
  4. Collaboration Document Definitions

Update a document definition

patch

/fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitions/{DocumentId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
  • 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
Nested Schema : Document Actions
Type: array
Title: Document Actions
The Document Actions resource manages the actions associated with a document definition.
Show Source
Nested Schema : Document Parameters
Type: array
Title: Document Parameters
The Document Parameters resource manages the parameters associated with a document definition.
Show Source
Nested Schema : Measures
Type: array
Title: Measures
The Measures resource manages the measures associated with a document definition.
Show Source
Nested Schema : collaborationDocumentDefinitions-documentActions-item-patch-request
Type: object
Show Source
Nested Schema : Document Action Participants
Type: array
Title: Document Action Participants
The Document Action Participants resource manages the participants associated with an action.
Show Source
Nested Schema : collaborationDocumentDefinitions-documentActions-documentActionParticipants-item-patch-request
Type: object
Show Source
  • Maximum Length: 30
    Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.
  • Maximum Length: 255
    Name of the participant for an action.
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Measure Actions
Type: array
Title: Measure Actions
The Measure Actions resource manages the actions associated with a document measure.
Show Source
Nested Schema : Measure Parameters
Type: array
Title: Measure Parameters
The Measure Parameters resource manages the parameters associated with the document measures.
Show Source
Nested Schema : collaborationDocumentDefinitions-measures-measureActions-item-patch-request
Type: object
Show Source
Nested Schema : Measure Action Participants
Type: array
Title: Measure Action Participants
The Measure Action Participants resource manages the participants associated with an action.
Show Source
Nested Schema : collaborationDocumentDefinitions-measures-measureActions-measureActionParticipants-item-patch-request
Type: object
Show Source
  • Maximum Length: 30
    Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.
  • Maximum Length: 255
    Name of the participant for an action.
Nested Schema : collaborationDocumentDefinitions-measures-measureParameters-item-patch-request
Type: object
Show Source
  • Maximum Length: 255
    Value of the parameter of the document measure.
  • Maximum Length: 255
    Second value of the parameter of the document measure. A list of accepted values is defined in the lookup type ORA_VCS_MEASURE_BOUNDARY_TYPE when the ParameterCode is MEASURE_HISTORY, MEASURE_HORIZON, or LOCKED_FENCE.
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 : collaborationDocumentDefinitions-item-response
Type: object
Show Source
Nested Schema : Document Actions
Type: array
Title: Document Actions
The Document Actions resource manages the actions associated with a document definition.
Show Source
Nested Schema : Document Parameters
Type: array
Title: Document Parameters
The Document Parameters resource manages the parameters associated with a document definition.
Show Source
Nested Schema : Measures
Type: array
Title: Measures
The Measures resource manages the measures associated with a document definition.
Show Source
Nested Schema : collaborationDocumentDefinitions-documentActions-item-response
Type: object
Show Source
Nested Schema : Document Action Participants
Type: array
Title: Document Action Participants
The Document Action Participants resource manages the participants associated with an action.
Show Source
Nested Schema : collaborationDocumentDefinitions-documentActions-documentActionParticipants-item-response
Type: object
Show Source
Nested Schema : collaborationDocumentDefinitions-documentParameters-item-response
Type: object
Show Source
Nested Schema : collaborationDocumentDefinitions-measures-item-response
Type: object
Show Source
Nested Schema : Measure Actions
Type: array
Title: Measure Actions
The Measure Actions resource manages the actions associated with a document measure.
Show Source
Nested Schema : Measure Parameters
Type: array
Title: Measure Parameters
The Measure Parameters resource manages the parameters associated with the document measures.
Show Source
Nested Schema : collaborationDocumentDefinitions-measures-measureActions-item-response
Type: object
Show Source
Nested Schema : Measure Action Participants
Type: array
Title: Measure Action Participants
The Measure Action Participants resource manages the participants associated with an action.
Show Source
Nested Schema : collaborationDocumentDefinitions-measures-measureActions-measureActionParticipants-item-response
Type: object
Show Source
Nested Schema : collaborationDocumentDefinitions-measures-measureParameters-item-response
Type: object
Show Source
Links
documentActions
Parameters:
  • DocumentId: $request.path.DocumentId
The Document Actions resource manages the actions associated with a document definition.
documentParameters
Parameters:
  • DocumentId: $request.path.DocumentId
The Document Parameters resource manages the parameters associated with a document definition.
measures
Parameters:
  • DocumentId: $request.path.DocumentId
The Measures resource manages the measures associated with a document definition.
Back to Top

Examples

This example describes how to update a xxxx.

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/versioncollaborationDocumentDefinitions/DocumentId/"
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.
                  

                  
{
    "SecondParameterValue":"ORA_VCS_CURRENT_WEEK"
}

                  

               
               
               

                  
Example Response Body

                  
                  
                  
The following example includes the contents of the response
                body in JSON format:
{
    "InstanceParameterId": -14018,
    "ParameterCode": "LOCKED_FENCE",
    "ParameterName": "Locked Time Fence",
    "ParameterValue": "2",
    "SecondParameterValue": "ORA_VCS_WEEKS",
    "CreatedBy": "SEED_DATA_FROM_APPLICATION",
    "CreationDate": "2021-11-12T18:07:56.301+00:00",
    "LastUpdatedBy": "COLLABPLANNER",
    "LastUpdateDate": "2021-11-19T22:16:49.034+00:00",
    "@context": {
        "key": "-14018",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/collaborationDocumentDefinitions/-10001/child/measures/-12003/child/measureParameters/-14018",
                "name": "measureParameters",
                "kind": "item"
            },
            {
                "rel": "canonical",
                "href": "https://servername/fscmRestApi/resources/version/collaborationDocumentDefinitions/-10001/child/measures/-12003/child/measureParameters/-14018",
                "name": "measureParameters",
                "kind": "item"
            },
            {
                "rel": "parent",
                "href": "https://servername/fscmRestApi/resources/version/collaborationDocumentDefinitions/-10001/child/measures/-12003",
                "name": "measures",
                "kind": "item"
            }
        ]
    }
}

                  
               

               
               
            

            
         
                 Back to Top