Jump to

• Request
• Response

Create measure quantities

post

/fscmRestApi/resources/11.13.18.05/collaborationCustomerDemandMeasureQuantities

Create measure quantities

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.

Supported Media Types

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

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

Root Schema : schema

Match All

Show Source

• object single-post-item
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/single-post-item"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : single-post-item

Type: object

Show Source

• SupplierId: integer (int64)
  Value that uniquely identifies the source supplier.

{
    "type":"object",
    "properties":{
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source supplier.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        }
    }
}

Nested Schema : type

Type: object

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object single-post-item
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/single-post-item"
        },
        {
            "type":"object"
        }
    ]
}

Nested Schema : single-post-item

Type: object

Show Source

• SupplierId: integer (int64)
  Value that uniquely identifies the source supplier.

{
    "type":"object",
    "properties":{
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the source supplier.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        }
    }
}

Nested Schema : type

Type: object

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 : collaborationCustomerDemandMeasureQuantities-item-response

Match All

Show Source

• object ItemProperties
• object collaborationCustomerDemandMeasureQuantities-item-response-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/collaborationCustomerDemandMeasureQuantities-item"
        },
        {
            "type":"object"
        }
    ]
}

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 : collaborationCustomerDemandMeasureQuantities-item

Type: object

Show Source

• CurrentCycleFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. If true, then the measure quantities are in the current planning cycle. If false, then the measure quantities have been expired and are in the previous planning cycle. This attribute does not have a default value.
• CustomerDemandId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration customer demand.
• CustomerId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration customer.
• CustomerName: string
  Read Only: true

  Maximum Length: 360

  Name of the customer.
• CustomerNumber: string
  Read Only: true

  Maximum Length: 360

  Number that identifies the customer.
• CustomerSiteId: string
  Read Only: true

  Maximum Length: 240

  Value that uniquely identifies the collaboration customer site.
• CustomerSiteLocation: string
  Read Only: true

  Maximum Length: 30

  Location of the customer site.
• CustomerSiteNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the customer site.
• Date: string
  Date on the measure.
• DisplayMeasureName: string
  Read Only: true

  Maximum Length: 80

  Name of the type of displayed measure used for collaboration.
• DocumentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the collaboration document type.
• DocumentMeasureId: integer (int64)
  Read Only: true

  Value that uniquely identifies the document measure.
• DocumentMeasureQuantitiesId: integer (int64)
  Read Only: true

  Value that uniquely identifies the document measure quantities.
• DocumentTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of document used for collaboration.
• DocumentTypeName: string
  Read Only: true

  Maximum Length: 30

  Type of document used 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.
• ItemLevelDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the defined item level of the collaboration customer demand.
• ItemLevelId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item level of the document.
• ItemLevelValue: string
  Read Only: true

  Maximum Length: 300

  Value of the defined item level of the collaboration customer demand.
• LastUpdateDate: string
  Read Only: true

  Date and time when the user most recently updated the measure quantities.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Login of the user who most recently updated the measure quantities.
• MeasureTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of measure used 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.
• OrganizationLevelDescription: string
  Read Only: true

  Maximum Length: 30

  Description of the defined organization level of the collaboration customer demand.
• OrganizationLevelId: integer (int64)
  Read Only: true

  Value that uniquely identifies the organization level of the document.
• OrganizationLevelValue: string
  Read Only: true

  Maximum Length: 30

  Value of the defined organization level of the collaboration customer demand.
• PublishedByUserName: string
  Read Only: true

  Maximum Length: 64

  Name of the user who published the customer demand measure data.
• PublishedDate: string
  Read Only: true

  Date when the customer demand measure data was published.
• Quantity: integer (int64)
  Quantity for a specified date on the measure.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 255

  Unit of measure for the item.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure for the item.

{
    "type":"object",
    "properties":{
        "CustomerDemandId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration customer demand.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        },
        "DocumentMeasureQuantitiesId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document measure quantities.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration document type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        },
        "DocumentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of document used for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "DocumentTypeName":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of document used for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration customer.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        },
        "CustomerName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the customer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CustomerNumber":{
            "maxLength":"360",
            "type":"string",
            "description":"Number that identifies the customer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CustomerSiteId":{
            "maxLength":"240",
            "type":"string",
            "description":"Value that uniquely identifies the collaboration customer site.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CustomerSiteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the customer site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CustomerSiteLocation":{
            "maxLength":"30",
            "type":"string",
            "description":"Location of the customer site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ItemLevelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item level of the document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        },
        "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,
            "x-hints":{
                "updatable":false
            }
        },
        "ItemLevelValue":{
            "maxLength":"300",
            "type":"string",
            "description":"Value of the defined item level of the collaboration customer demand.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ItemLevelDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the defined item level of the collaboration customer demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "UOMCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure for the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "UnitOfMeasure":{
            "maxLength":"255",
            "type":"string",
            "description":"Unit of measure for the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "OrganizationLevelId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization level of the document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        },
        "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":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "OrganizationLevelValue":{
            "maxLength":"30",
            "type":"string",
            "description":"Value of the defined organization level of the collaboration customer demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "OrganizationLevelDescription":{
            "maxLength":"30",
            "type":"string",
            "description":"Description of the defined organization level of the collaboration customer demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "MeasureTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of measure used for collaboration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "DisplayMeasureName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the type of displayed measure used for collaboration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "CurrentCycleFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the measure quantities are in the current planning cycle. If false, then the measure quantities have been expired and are in the previous planning cycle. This attribute does not have a default value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "Date":{
            "type":"string",
            "description":"Date on the measure.",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "Quantity":{
            "type":"integer",
            "description":"Quantity for a specified date on the measure.",
            "format":"int64",
            "nullable":false,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-precision":"18"
            }
        },
        "PublishedByUserName":{
            "maxLength":"64",
            "type":"string",
            "description":"Name of the user who published the customer demand measure data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "PublishedDate":{
            "type":"string",
            "description":"Date when the customer demand measure data was published.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "DocumentMeasureId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false,
                "adf-precision":"18"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Login of the user who most recently updated the measure quantities.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the measure quantities.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    },
    "x-links":[
        {
            "rel":"self",
            "method":"get",
            "title":"self",
            "href":"/fscmRestApi/scc/collaborationCustomerDemandMeasureQuantities/{collaborationCustomerDemandMeasureQuantities_Id}"
        },
        {
            "rel":"canonical",
            "method":"get",
            "title":"canonical",
            "href":"/fscmRestApi/scc/collaborationCustomerDemandMeasureQuantities/{collaborationCustomerDemandMeasureQuantities_Id}"
        }
    ]
}

Relationships

canonical

Method: get

Path: /fscmRestApi/scc/collaborationCustomerDemandMeasureQuantities/{collaborationCustomerDemandMeasureQuantities_Id}

self

Method: get

Path: /fscmRestApi/scc/collaborationCustomerDemandMeasureQuantities/{collaborationCustomerDemandMeasureQuantities_Id}

Nested Schema : collaborationCustomerDemandMeasureQuantities-item-response-allOf[2]

Type: object

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