Jump to

• Request
• Response

Create data access security

post

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

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

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

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-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."
        }
    }
}

Back to Top