Jump to

• Request
• Response
• Examples

Create demand planners

post

/fscmRestApi/resources/11.13.18.05/collaborationDemandPlanners

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• Email: string
  Title: Email

  Maximum Length: 240

  Primary work email of the user.
• 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.
• 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.
• 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(required): string
  Maximum Length: 100

  Login that the demand planner used to directly authenticate with the service provider. This attribute is required.

{
    "required":[
        "UserName"
    ],
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "FullAccessFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "UserName":{
            "maxLength":"100",
            "type":"string",
            "description":"Login that the demand planner used to directly authenticate with the service provider. This attribute is required.",
            "nullable":false
        },
        "Email":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"Primary work email of the user.",
            "nullable":true
        },
        "dataAccessSecurity":{
            "title":"Data Access Security",
            "type":"array",
            "description":"The Data Access Security resource manages the data assess security for the demand planner.",
            "items":{
                "$ref":"#/components/schemas/collaborationDemandPlanners-dataAccessSecurity-item-post-request"
            }
        },
        "LastName":{
            "maxLength":"150",
            "type":"string",
            "description":"Person last name.",
            "nullable":true
        },
        "PersonPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the status of the demand planner.",
            "nullable":true,
            "default":"ORA_VCS_ACTIVE"
        },
        "ParticipantCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the user's participant type. A list of accepted values is ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.",
            "nullable":true
        },
        "documentVisibility":{
            "title":"Document Visibility",
            "type":"array",
            "description":"The Document Visibility resource manages the visibility to documents for the demand planner.",
            "items":{
                "$ref":"#/components/schemas/collaborationDemandPlanners-documentVisibility-item-post-request"
            }
        }
    }
}

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

• Array of: object collaborationDemandPlanners-dataAccessSecurity-item-post-request

{
    "title":"Data Access Security",
    "type":"array",
    "description":"The Data Access Security resource manages the data assess security for the demand planner.",
    "items":{
        "$ref":"#/components/schemas/collaborationDemandPlanners-dataAccessSecurity-item-post-request"
    }
}

Nested Schema : Document Visibility

Type: array

Title: Document Visibility

The Document Visibility resource manages the visibility to documents for the demand planner.

Show Source

• Array of: object collaborationDemandPlanners-documentVisibility-item-post-request

{
    "title":"Document Visibility",
    "type":"array",
    "description":"The Document Visibility resource manages the visibility to documents for the demand planner.",
    "items":{
        "$ref":"#/components/schemas/collaborationDemandPlanners-documentVisibility-item-post-request"
    }
}

Nested Schema : collaborationDemandPlanners-dataAccessSecurity-item-post-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CustomerSiteId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CustomerNumber":{
            "maxLength":"360",
            "type":"string",
            "description":"Number that identifies the customer in the customer forecast that receives the item.",
            "nullable":true
        },
        "SecurityContextCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.",
            "nullable":false
        },
        "CustomerId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CustomerName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the customer in the customer forecast that receives the item.",
            "nullable":true
        },
        "CustomerSiteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies customer site in the customer forecast that receives the item.",
            "nullable":true
        }
    }
}

Nested Schema : collaborationDemandPlanners-documentVisibility-item-post-request

Type: object

Show Source

• DocumentTypeCode: string
  Abbreviation that identifies the type of document used for collaboration.

{
    "type":"object",
    "properties":{
        "DocumentTypeCode":{
            "type":"string",
            "description":"Abbreviation that identifies the type of document used for collaboration.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : collaborationDemandPlanners-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the demand planner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the demand planner.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the demand planner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserName":{
            "maxLength":"100",
            "type":"string",
            "description":"Login that the demand planner used to directly authenticate with the service provider. This attribute is required.",
            "nullable":false,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"Primary work email of the user.",
            "nullable":true,
            "x-queryable":true
        },
        "ListName":{
            "maxLength":"240",
            "type":"string",
            "description":"Listed name of the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "maxLength":"150",
            "type":"string",
            "description":"Person first name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "dataAccessSecurity":{
            "title":"Data Access Security",
            "type":"array",
            "description":"The Data Access Security resource manages the data assess security for the demand planner.",
            "items":{
                "$ref":"#/components/schemas/collaborationDemandPlanners-dataAccessSecurity-item-response"
            }
        },
        "DemandPlannerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand planner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"The user's participant type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the status of the demand planner.",
            "nullable":true,
            "default":"ORA_VCS_ACTIVE",
            "x-queryable":true
        },
        "ParticipantCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the user's participant type. A list of accepted values is ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.",
            "nullable":true,
            "x-queryable":true
        },
        "FullAccessFlag":{
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the user displayed on the UI.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastName":{
            "maxLength":"150",
            "type":"string",
            "description":"Person last name.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the demand planner.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "documentVisibility":{
            "title":"Document Visibility",
            "type":"array",
            "description":"The Document Visibility resource manages the visibility to documents for the demand planner.",
            "items":{
                "$ref":"#/components/schemas/collaborationDemandPlanners-documentVisibility-item-response"
            }
        }
    }
}

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

• Array of: object collaborationDemandPlanners-dataAccessSecurity-item-response

{
    "title":"Data Access Security",
    "type":"array",
    "description":"The Data Access Security resource manages the data assess security for the demand planner.",
    "items":{
        "$ref":"#/components/schemas/collaborationDemandPlanners-dataAccessSecurity-item-response"
    }
}

Nested Schema : Document Visibility

Type: array

Title: Document Visibility

The Document Visibility resource manages the visibility to documents for the demand planner.

Show Source

• Array of: object collaborationDemandPlanners-documentVisibility-item-response

{
    "title":"Document Visibility",
    "type":"array",
    "description":"The Document Visibility resource manages the visibility to documents for the demand planner.",
    "items":{
        "$ref":"#/components/schemas/collaborationDemandPlanners-documentVisibility-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : collaborationDemandPlanners-dataAccessSecurity-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the data access security.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the data access security.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the data access security.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerSiteLocation":{
            "maxLength":"30",
            "type":"string",
            "description":"Location of the customer site in the customer forecast that receives the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSiteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies customer site in the customer forecast that receives the item.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerNumber":{
            "maxLength":"360",
            "type":"string",
            "description":"Number that identifies the customer in the customer forecast that receives the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SecurityContextCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerSiteAddress":{
            "maxLength":"960",
            "type":"string",
            "description":"Address of the customer site in the customer forecast that receives the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecurityContext":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the level of security applied. Values include Customer or Customer Site. The default value is Customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomerName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the customer in the customer forecast that receives the item.",
            "nullable":true,
            "x-queryable":true
        },
        "DataAccessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the specific data security access granted to the demand planner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the data access security.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : collaborationDemandPlanners-documentVisibility-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "OrganizationLevel":{
            "maxLength":"80",
            "type":"string",
            "description":"Level of the organization a document accepts for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"Current state of the document definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerLevel":{
            "maxLength":"80",
            "type":"string",
            "description":"Level of the customer a document accepts for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document definition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the current state of the document definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemLevel":{
            "maxLength":"80",
            "type":"string",
            "description":"Level of the item a document accepts for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the item level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ITEM.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the organization level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ORGANIZATION.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the customer level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_CUSTOMER.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "type":"string",
            "description":"Abbreviation that identifies the type of document used for collaboration.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocumentVisibilityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the specific document visibility assigned to the demand planner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentTypeName":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of document used for collaboration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

dataAccessSecurity

Operation: /fscmRestApi/resources/11.13.18.05/collaborationDemandPlanners/{collaborationDemandPlannersUniqID}/child/dataAccessSecurity

Parameters:

• collaborationDemandPlannersUniqID: $request.path.collaborationDemandPlannersUniqID

The Data Access Security resource manages the data assess security for the demand planner.

documentVisibility

Operation: /fscmRestApi/resources/11.13.18.05/collaborationDemandPlanners/{collaborationDemandPlannersUniqID}/child/documentVisibility

Parameters:

• collaborationDemandPlannersUniqID: $request.path.collaborationDemandPlannersUniqID

The Document Visibility resource manages the visibility to documents for the demand planner.

Back to Top

Examples

This example describes how to create enterprise and customer users who can collaborate on customer forecasts.

.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/collaborationDemandPlanners"

Example Request Body

The following example includes the contents of the request body in JSON format. In this example, a file attahment is uploaded to the purchase order header successfully. 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 creates.

{
    "ParticipantCode":"ORA_VCS_ENTERPRISE",
    "UserName":"mark.roman",
    "FullAccessFlag": "true",
    "documentVisibility": [
        {
            "DocumentTypeCode": "VCS_CONSUMPTION"
        },
        {
            "DocumentTypeCode": "VCS_FORECAST"
        }
    ]
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "DemandPlannerId": 300100548703055,
    "UserName": "mark.roman",
    "DisplayName": null,
    "ListName": null,
    "Email": null,
    "StatusCode": "ORA_VCS_ACTIVE",
    "Status": null,
    "CreatedBy": "COLLABPLANNER",
    "CreationDate": "2021-11-19T21:18:07+00:00",
    "LastUpdatedBy": "COLLABPLANNER",
    "LastUpdateDate": "2021-11-19T21:18:07.455+00:00",
    "FullAccessFlag": "false",
    "FirstName": null,
    "LastName": null,
    "ParticipantCode": "ORA_VCS_ENTERPRISE",
    "ParticipantName": null,
    "PersonPartyId": null,
    "dataAccessSecurity": {
        "items": [
            {
                "DataAccessId": 300100548703056,
                "SecurityContextCode": "ORA_VCS_CUSTOMER",
                "SecurityContext": null,
                "CustomerId": 300100138826553,
                "CustomerNumber": null,
                "CustomerName": "California Fitness",
                "CustomerSiteId": null,
                "CustomerSiteNumber": null,
                "CustomerSiteAddress": null,
                "CustomerSiteLocation": null,
                "CreatedBy": "COLLABPLANNER",
                "CreationDate": "2021-11-19T21:18:07.147+00:00",
                "LastUpdatedBy": "COLLABPLANNER",
                "LastUpdateDate": "2021-11-19T21:18:07.455+00:00",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055/child/dataAccessSecurity/300100548703056",
                        "name": "dataAccessSecurity",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055/child/dataAccessSecurity/300100548703056",
                        "name": "dataAccessSecurity",
                        "kind": "item"
                    },
                    {
                        "rel": "parent",
                        "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055",
                        "name": "collaborationDemandPlanners",
                        "kind": "item"
                    }
                ]
            }
        ],
        "count": 1,
        "hasMore": false,
        "limit": 25,
        "offset": 0,
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055/child/dataAccessSecurity",
                "name": "dataAccessSecurity",
                "kind": "collection"
            }
        ]
    },
    "documentVisibility": {
        "items": [
            {
                "DocumentVisibilityId": 300100548703057,
                "DocumentId": -10002,
                "DocumentTypeCode": null,
                "DocumentTypeName": null,
                "CustomerLevelCode": null,
                "CustomerLevel": null,
                "OrganizationLevelCode": null,
                "OrganizationLevel": null,
                "ItemLevelCode": null,
                "ItemLevel": null,
                "StatusCode": null,
                "Status": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055/child/documentVisibility/300100548703057",
                        "name": "documentVisibility",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055/child/documentVisibility/300100548703057",
                        "name": "documentVisibility",
                        "kind": "item"
                    },
                    {
                        "rel": "parent",
                        "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055",
                        "name": "collaborationDemandPlanners",
                        "kind": "item"
                    }
                ]
            },
            {
                "DocumentVisibilityId": 300100548703058,
                "DocumentId": -10001,
                "DocumentTypeCode": null,
                "DocumentTypeName": null,
                "CustomerLevelCode": null,
                "CustomerLevel": null,
                "OrganizationLevelCode": null,
                "OrganizationLevel": null,
                "ItemLevelCode": null,
                "ItemLevel": null,
                "StatusCode": null,
                "Status": null,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055/child/documentVisibility/300100548703058",
                        "name": "documentVisibility",
                        "kind": "item",
                        "properties": {
                            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                        }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055/child/documentVisibility/300100548703058",
                        "name": "documentVisibility",
                        "kind": "item"
                    },
                    {
                        "rel": "parent",
                        "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055",
                        "name": "collaborationDemandPlanners",
                        "kind": "item"
                    }
                ]
            }
        ],
        "count": 2,
        "hasMore": false,
        "limit": 25,
        "offset": 0,
        "links": [
            {
                "rel": "self",
                "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055/child/documentVisibility",
                "name": "documentVisibility",
                "kind": "collection"
            }
        ]
    },
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055",
            "name": "collaborationDemandPlanners",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055",
            "name": "collaborationDemandPlanners",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055/child/dataAccessSecurity",
            "name": "dataAccessSecurity",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/collaborationDemandPlanners/300100548703055/child/documentVisibility",
            "name": "documentVisibility",
            "kind": "collection"
        }
    ]
}

Back to Top