Jump to

• Request
• Response

Create details

post

/fscmRestApi/resources/11.13.18.05/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details

Create details for a customer demand request

Request

Path Parameters

• collaborationCustomerDemandRequests_Id(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Date: string (date)
  Title: Date

  Date on the measure.
• DetailsId: number
  Title: Details ID

  Read Only: true

  Value that uniquely identifies the detail for the customer demand request.
• Quantity: number
  Title: Quantity

  Quantity for a specified date on the measure.

{
    "type":"object",
    "properties":{
        "DetailsId":{
            "title":"Details ID",
            "type":"number",
            "description":"Value that uniquely identifies the detail for the customer demand request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "Date":{
            "title":"Date",
            "type":"string",
            "description":"Date on the measure.",
            "format":"date",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity for a specified date on the measure.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        }
    },
    "x-links":[
        {
            "rel":"self",
            "method":"get",
            "title":"self",
            "href":"/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}"
        },
        {
            "rel":"parent",
            "method":"get",
            "title":"parent",
            "href":"/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}"
        },
        {
            "rel":"canonical",
            "method":"get",
            "title":"canonical",
            "href":"/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}"
        }
    ]
}

Relationships

canonical

Method: get

Path: /fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}

parent

Method: get

Path: /fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}

self

Method: get

Path: /fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}

Request Body - application/vnd.oracle.adf.resourceitem+json ()

Root Schema : schema

Type: object

Show Source

• Date: string (date)
  Title: Date

  Date on the measure.
• DetailsId: number
  Title: Details ID

  Read Only: true

  Value that uniquely identifies the detail for the customer demand request.
• Quantity: number
  Title: Quantity

  Quantity for a specified date on the measure.

{
    "type":"object",
    "properties":{
        "DetailsId":{
            "title":"Details ID",
            "type":"number",
            "description":"Value that uniquely identifies the detail for the customer demand request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "Date":{
            "title":"Date",
            "type":"string",
            "description":"Date on the measure.",
            "format":"date",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity for a specified date on the measure.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        }
    },
    "x-links":[
        {
            "rel":"self",
            "method":"get",
            "title":"self",
            "href":"/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}"
        },
        {
            "rel":"parent",
            "method":"get",
            "title":"parent",
            "href":"/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}"
        },
        {
            "rel":"canonical",
            "method":"get",
            "title":"canonical",
            "href":"/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}"
        }
    ]
}

Relationships

canonical

Method: get

Path: /fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}

parent

Method: get

Path: /fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}

self

Method: get

Path: /fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• 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 : collaborationCustomerDemandRequests-details-item-response

Match All

Show Source

• object ItemProperties

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/collaborationCustomerDemandRequests-details-item"
        }
    ]
}

Nested Schema : ItemProperties

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.

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

Nested Schema : schema

Type: object

Show Source

• Date: string (date)
  Title: Date

  Date on the measure.
• DetailsId: number
  Title: Details ID

  Read Only: true

  Value that uniquely identifies the detail for the customer demand request.
• Quantity: number
  Title: Quantity

  Quantity for a specified date on the measure.

{
    "type":"object",
    "properties":{
        "DetailsId":{
            "title":"Details ID",
            "type":"number",
            "description":"Value that uniquely identifies the detail for the customer demand request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "Date":{
            "title":"Date",
            "type":"string",
            "description":"Date on the measure.",
            "format":"date",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity for a specified date on the measure.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        }
    },
    "x-links":[
        {
            "rel":"self",
            "method":"get",
            "title":"self",
            "href":"/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}"
        },
        {
            "rel":"parent",
            "method":"get",
            "title":"parent",
            "href":"/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}"
        },
        {
            "rel":"canonical",
            "method":"get",
            "title":"canonical",
            "href":"/fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}"
        }
    ]
}

Relationships

canonical

Method: get

Path: /fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}

parent

Method: get

Path: /fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}

self

Method: get

Path: /fscmRestApi/scc/collaborationCustomerDemandRequests/{collaborationCustomerDemandRequests_Id}/details/{collaborationCustomerDemandRequests_Details_Id}

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