REST API for Oracle Supply Chain Management Cloud

Get one demand planner

get

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

Query Parameters

dependency: string

This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

Format: <attr1>=<val1>,<attr2>=<value2>
expand: string

When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
fields: string

This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

Format: ?fields=Attribute1,Attribute2

Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
links: string

This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

Example:
self,canonical
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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