Update a demand planner
patch
/fscmRestApi/resources/11.13.18.05/collaborationDemandPlanners/{collaborationDemandPlannersUniqID}
Request
Path Parameters
-
collaborationDemandPlannersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Collaboration Demand Planners resource and used to uniquely identify an instance of Collaboration Demand Planners. The client should not generate the hash key value. Instead, the client should query on the Collaboration Demand Planners collection resource in order to navigate to a specific instance of Collaboration Demand Planners to get the hash key.
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
-
dataAccessSecurity: array
Data Access Security
Title:
Data Access Security
The Data Access Security resource manages the data assess security for the demand planner. -
documentVisibility: array
Document Visibility
Title:
Document Visibility
The Document Visibility resource manages the visibility to documents for the demand planner. -
FullAccessFlag: boolean
Contains one of the following values: Yes or No. If Yes, then the demand planner has access to the entire customer forecast data. If No, then the demand planner doesn't have access to the entire customer forecast data. The default value is No.
-
Status: string
Maximum Length:
80
Value that indicates the administrative status of the demand planner. The service provider determines the definitive value for this attribute. For example, Active indicates that the demand planner can access order forecast data, and Inactive indicates that the demand planner can't access order forecast data. The default value is Active. -
StatusCode: string
Maximum Length:
30
Default Value:ORA_VCS_ACTIVE
Abbreviation that identifies the status of the demand planner.
Nested Schema : Data Access Security
Type:
array
Title:
Data Access Security
The Data Access Security resource manages the data assess security for the demand planner.
Show Source
Nested Schema : Document Visibility
Type:
array
Title:
Document Visibility
The Document Visibility resource manages the visibility to documents for the demand planner.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CustomerId: integer
(int64)
Value that uniquely identifies the customer in the customer forecast that receives the item. It's a primary key that the application creates when it creates the customer.
-
CustomerName: string
Maximum Length:
360
Name of the customer in the customer forecast that receives the item. -
CustomerNumber: string
Maximum Length:
360
Number that identifies the customer in the customer forecast that receives the item. -
CustomerSiteId: integer
(int64)
Value that uniquely identifies the customer site in the customer forecast that receives the item. It's a primary key that the application creates when it creates the customer.
-
CustomerSiteNumber: string
Maximum Length:
30
Number that identifies customer site in the customer forecast that receives the item. -
SecurityContextCode: string
Maximum Length:
30
Abbreviation that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.
Nested Schema : collaborationDemandPlanners-documentVisibility-item-patch-request
Type:
Show Source
object
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 : collaborationDemandPlanners-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the demand planner. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the demand planner. -
dataAccessSecurity: array
Data Access Security
Title:
Data Access Security
The Data Access Security resource manages the data assess security for the demand planner. -
DemandPlannerId: integer
(int64)
Read Only:
true
Value that uniquely identifies the demand planner. -
DisplayName: string
Read Only:
true
Maximum Length:240
Name of the user displayed on the UI. -
documentVisibility: array
Document Visibility
Title:
Document Visibility
The Document Visibility resource manages the visibility to documents for the demand planner. -
Email: string
Title:
Email
Maximum Length:240
Primary work email of the user. -
FirstName: string
Read Only:
true
Maximum Length:150
Person first name. -
FullAccessFlag: boolean
Contains one of the following values: Yes or No. If Yes, then the demand planner has access to the entire customer forecast data. If No, then the demand planner doesn't have access to the entire customer forecast data. The default value is No.
-
LastName: string
Maximum Length:
150
Person last name. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the demand planner. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the demand planner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListName: string
Read Only:
true
Maximum Length:240
Listed name of the user. -
ParticipantCode: string
Maximum Length:
30
Abbreviation that identifies the user's participant type. A list of accepted values is ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE. -
ParticipantName: string
Title:
Meaning
Read Only:true
Maximum Length:80
The user's participant type. -
PersonPartyId: integer
(int64)
Value that uniquely identifies the customer contact.
-
Status: string
Maximum Length:
80
Value that indicates the administrative status of the demand planner. The service provider determines the definitive value for this attribute. For example, Active indicates that the demand planner can access order forecast data, and Inactive indicates that the demand planner can't access order forecast data. The default value is Active. -
StatusCode: string
Maximum Length:
30
Default Value:ORA_VCS_ACTIVE
Abbreviation that identifies the status of the demand planner. -
UserName: string
Maximum Length:
100
Login that the demand planner used to directly authenticate with the service provider. This attribute is required.
Nested Schema : Data Access Security
Type:
array
Title:
Data Access Security
The Data Access Security resource manages the data assess security for the demand planner.
Show Source
Nested Schema : Document Visibility
Type:
array
Title:
Document Visibility
The Document Visibility resource manages the visibility to documents for the demand planner.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : collaborationDemandPlanners-dataAccessSecurity-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the data access security. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the data access security. -
CustomerId: integer
(int64)
Value that uniquely identifies the customer in the customer forecast that receives the item. It's a primary key that the application creates when it creates the customer.
-
CustomerName: string
Maximum Length:
360
Name of the customer in the customer forecast that receives the item. -
CustomerNumber: string
Maximum Length:
360
Number that identifies the customer in the customer forecast that receives the item. -
CustomerSiteAddress: string
Read Only:
true
Maximum Length:960
Address of the customer site in the customer forecast that receives the item. -
CustomerSiteId: integer
(int64)
Value that uniquely identifies the customer site in the customer forecast that receives the item. It's a primary key that the application creates when it creates the customer.
-
CustomerSiteLocation: string
Read Only:
true
Maximum Length:30
Location of the customer site in the customer forecast that receives the item. -
CustomerSiteNumber: string
Maximum Length:
30
Number that identifies customer site in the customer forecast that receives the item. -
DataAccessId: integer
(int64)
Read Only:
true
Value that uniquely identifies the specific data security access granted to the demand planner. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the data access security. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the data access security. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SecurityContext: string
Read Only:
true
Maximum Length:80
Value that identifies the level of security applied. Values include Customer or Customer Site. The default value is Customer. -
SecurityContextCode: string
Maximum Length:
30
Abbreviation that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.
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 : collaborationDemandPlanners-documentVisibility-item-response
Type:
Show Source
object
-
CustomerLevel: string
Read Only:
true
Maximum Length:80
Level of the customer a document accepts for collaboration. -
CustomerLevelCode: string
Read Only:
true
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. -
DocumentId: integer
(int64)
Read Only:
true
Value that uniquely identifies the document definition. -
DocumentTypeCode: string
Abbreviation that identifies the type of document used for collaboration.
-
DocumentTypeName: string
Read Only:
true
Maximum Length:80
Type of document used for collaboration. -
DocumentVisibilityId: integer
(int64)
Read Only:
true
Value that uniquely identifies the specific document visibility assigned to the demand planner. -
ItemLevel: string
Read Only:
true
Maximum Length:80
Level of the item a document accepts for collaboration. -
ItemLevelCode: string
Read Only:
true
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationLevel: string
Read Only:
true
Maximum Length:80
Level of the organization a document accepts for collaboration. -
OrganizationLevelCode: string
Read Only:
true
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
Read Only:
true
Maximum Length:80
Current state of the document definition. -
StatusCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the current state of the document definition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- dataAccessSecurity
-
Parameters:
- collaborationDemandPlannersUniqID:
$request.path.collaborationDemandPlannersUniqID
The Data Access Security resource manages the data assess security for the demand planner. - collaborationDemandPlannersUniqID:
- documentVisibility
-
Parameters:
- collaborationDemandPlannersUniqID:
$request.path.collaborationDemandPlannersUniqID
The Document Visibility resource manages the visibility to documents for the demand planner. - collaborationDemandPlannersUniqID: