Update a document definition
patch
/fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitions/{DocumentId}
Request
Path Parameters
-
DocumentId(required): integer(int64)
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
-
Metadata-Context:
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".
-
REST-Framework-Version:
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
- application/json
Root Schema : schema
Type:
Show Source
object
-
documentActions: array
Document Actions
Title:
Document Actions
The Document Actions resource manages the actions associated with a document definition. -
documentParameters: array
Document Parameters
Title:
Document Parameters
The Document Parameters resource manages the parameters associated with a document definition. -
DocumentTypeName: string
Maximum Length:
80
Type of document used for collaboration. -
measures: array
Measures
Title:
Measures
The Measures resource manages the measures associated with a document definition. -
Status: string
Maximum Length:
80
Current state of the document definition. -
StatusCode: string
Maximum Length:
30
Abbreviation that identifies the current state of the document definition.
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:
Show Source
object
-
documentActionParticipants: array
Document Action Participants
Title:
Document Action Participants
The Document Action Participants resource manages the participants associated with an action.
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:
Show Source
object
-
ParticipantCode: string
Maximum Length:
30
Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE. -
ParticipantName: string
Maximum Length:
255
Name of the participant for an action.
Nested Schema : schema
Type:
Show Source
object
-
ParameterValue: string
Maximum Length:
255
Value of the parameter of the document definition. -
SecondParameterValue: string
Maximum Length:
255
This attribute isn't currently used.
Nested Schema : schema
Type:
Show Source
object
-
measureActions: array
Measure Actions
Title:
Measure Actions
The Measure Actions resource manages the actions associated with a document measure. -
measureParameters: array
Measure Parameters
Title:
Measure Parameters
The Measure Parameters resource manages the parameters associated with the document measures. -
ParticipantOwnerCode: string
Maximum Length:
30
Abbreviation that identifies the measure's participant owner. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.
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:
Show Source
object
-
measureActionParticipants: array
Measure Action Participants
Title:
Measure Action Participants
The Measure Action Participants resource manages the participants associated with an action.
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:
Show Source
object
-
ParticipantCode: string
Maximum Length:
30
Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE. -
ParticipantName: string
Maximum Length:
255
Name of the participant for an action.
Nested Schema : collaborationDocumentDefinitions-measures-measureParameters-item-patch-request
Type:
Show Source
object
-
ParameterValue: string
Maximum Length:
255
Value of the parameter of the document measure. -
SecondParameterValue: string
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : collaborationDocumentDefinitions-item-response
Type:
Show Source
object
-
CollaborationObjectCode: string
Maximum Length:
30
Abbreviation that identifies the object the document uses to determine what dimension levels are required. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the document definition. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the document definition. -
CustomerLevel: string
Read Only:
true
Maximum Length:80
Level of the customer a document accepts for collaboration. -
CustomerLevelCode: string
Maximum Length:
30
Abbreviation that identifies the customer level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_CUSTOMER. -
documentActions: array
Document Actions
Title:
Document Actions
The Document Actions resource manages the actions associated with a document definition. -
DocumentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the document definition. -
documentParameters: array
Document Parameters
Title:
Document Parameters
The Document Parameters resource manages the parameters associated with a document definition. -
DocumentTypeCode: string
Maximum Length:
60
Abbreviation that identifies the type of document used for collaboration. -
DocumentTypeName: string
Maximum Length:
80
Type of document used for collaboration. -
ItemLevel: string
Read Only:
true
Maximum Length:80
Level of the item a document accepts for collaboration. -
ItemLevelCode: string
Maximum Length:
30
Abbreviation that identifies the item level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ITEM. -
ItemResolution: string
Read Only:
true
Maximum Length:80
Resolution used to identify the item name. -
ItemResolutionCode: string
Maximum Length:
30
Abbreviation that identifies the item name resolution when the item level code is ORA_ITEM. A list of accepted values is defined in the lookup type ORA_VCS_ITEM_RESOLUTION. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the document definition. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the document definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
measures: array
Measures
Title:
Measures
The Measures resource manages the measures associated with a document definition. -
OrganizationLevel: string
Read Only:
true
Maximum Length:80
Level of the organization a document accepts for collaboration. -
OrganizationLevelCode: string
Maximum Length:
30
Abbreviation that identifies the organization level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ORGANIZATION. -
Status: string
Maximum Length:
80
Current state of the document definition. -
StatusCode: string
Maximum Length:
30
Abbreviation that identifies the current state of the document definition.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
ActionCode: string
Maximum Length:
30
Abbreviation that identifies the type of action for a document definition. A list of accepted values is defined in the lookup type ORA_VCS_DOC_ACTIONS. -
ActionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the action for a document definition. -
ActionName: string
Name of the action for a document.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the document action. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the document action. -
documentActionParticipants: array
Document Action Participants
Title:
Document Action Participants
The Document Action Participants resource manages the participants associated with an action. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the document action. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the document action. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : collaborationDocumentDefinitions-documentActions-documentActionParticipants-item-response
Type:
Show Source
object
-
ActionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the action for a document definition. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the document action participant. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the document action participant. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the document action participant. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the document action participant. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantCode: string
Maximum Length:
30
Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE. -
ParticipantId: integer
(int64)
Read Only:
true
Value that uniquely identifies the participant for an action. -
ParticipantName: string
Maximum Length:
255
Name of the participant for an action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : collaborationDocumentDefinitions-documentParameters-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the document parameter. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the document parameter. -
InstanceParameterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the instance of the document parameter. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the document parameter. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the document parameter. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParameterCode: string
Maximum Length:
100
Abbreviation that identifies the parameter of the document definition. -
ParameterName: string
Read Only:
true
Maximum Length:80
Name of the parameter of the document definition. -
ParameterValue: string
Maximum Length:
255
Value of the parameter of the document definition. -
SecondParameterValue: string
Maximum Length:
255
This attribute isn't currently used.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : collaborationDocumentDefinitions-measures-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the document measure. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the document measure. -
DataTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the type of measure data. -
DocumentMeasureId: integer
(int64)
Read Only:
true
Value that uniquely identifies the document measure. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the document measure. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the document measure. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
measureActions: array
Measure Actions
Title:
Measure Actions
The Measure Actions resource manages the actions associated with a document measure. -
MeasureId: integer
(int64)
Value that uniquely identifies the measure definition.
-
measureParameters: array
Measure Parameters
Title:
Measure Parameters
The Measure Parameters resource manages the parameters associated with the document measures. -
MeasureTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of measure used for collaboration. -
MeasureTypeName: string
Name of the type of measure used for collaboration.
-
ParticipantOwnerCode: string
Maximum Length:
30
Abbreviation that identifies the measure's participant owner. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE. -
ParticipantOwnerName: string
Read Only:
true
Maximum Length:80
Name of the measure's owning participant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
ActionCode: string
Maximum Length:
30
Abbreviation that identifies the type of action for a document measure. A list of accepted values is defined in the lookup type ORA_VCS_MEASURE_ACTIONS. -
ActionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the action for a document measure. -
ActionName: string
Name of the action for a document measure.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the measure action. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the measure action. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the measure action. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the measure action. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
measureActionParticipants: array
Measure Action Participants
Title:
Measure Action Participants
The Measure Action Participants resource manages the participants associated with an action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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:
Show Source
object
-
ActionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the action for a document measure. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the measure action participant. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the measure action participant. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the measure action participant. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the measure action participant. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParticipantCode: string
Maximum Length:
30
Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE. -
ParticipantId: integer
(int64)
Read Only:
true
Value that uniquely identifies the participant for an action. -
ParticipantName: string
Maximum Length:
255
Name of the participant for an action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : collaborationDocumentDefinitions-measures-measureParameters-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the measure parameter. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the measure parameter. -
InstanceParameterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the instance of the measure parameter. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the measure parameter. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the measure parameter. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParameterCode: string
Maximum Length:
100
Abbreviation that identifies the parameter on the document measure. -
ParameterName: string
Read Only:
true
Maximum Length:80
Name of the parameter of the document measure. -
ParameterValue: string
Maximum Length:
255
Value of the parameter of the document measure. -
SecondParameterValue: string
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- documentActions
-
Parameters:
- DocumentId:
$request.path.DocumentId
The Document Actions resource manages the actions associated with a document definition. - DocumentId:
- documentParameters
-
Parameters:
- DocumentId:
$request.path.DocumentId
The Document Parameters resource manages the parameters associated with a document definition. - DocumentId:
- measures
-
Operation: /fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitions/{DocumentId}/child/measuresParameters:
- DocumentId:
$request.path.DocumentId
The Measures resource manages the measures associated with a document definition. - DocumentId:
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" } ] } }