Jump to

• Request
• Response
• Examples

Create schedules

post

/fscmRestApi/resources/11.13.18.05/cycleCountSchedules

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

• CountZeroQuantityFlag: boolean
  Contains one of the following values: true or false. If true, then count the locations that contains zero quantity. If false, then do not count the locations that contains zero quantity. The default value is false.
• CycleCountHeaderId: integer (int64)
  Value that uniquely identifies the cycle count definition.
• CycleCountName: string
  Maximum Length: 255

  Name of the cycle count.
• CycleCountScheduleId: integer (int64)
  Value that uniquely identifies the cycle count schedule.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item number.
• ItemNumber: string
  Maximum Length: 255

  Number that identifies the inventory item.
• Locator: string
  Maximum Length: 255

  Value that identifies physical area, such as a row, rack, aisle, bin, or shelf in the subinventory that stores material.
• LocatorId: integer (int64)
  Title: Locator

  Value that uniquely identifies the locator.
• LotNumber: string
  Title: Lot

  Maximum Length: 80

  Number that identifies a set of items that are being counted, which are produced together and share the same production costs and specifications.
• OrganizationCode: string
  Maximum Length: 255

  Value that identifies the inventory organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization.
• RequestSourceTypeCode: integer (int64)
  Value that indicates the manner in which the count schedule was created. A list of possible values is defined in the lookup type INV_CC_APPROVAL_TYPES.
• Revision: string
  Maximum Length: 18

  Value that identifies the version of the item.
• ScheduleDate: string (date)
  Title: Schedule Date

  Date when the count was scheduled.
• ScheduleStatusCode: integer (int64)
  Value that indicates the schedule status. A list of possible values is defined in the lookup type ORA_INV_CC_SCHEDULE_STATUS.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Number that identifies a single quantity of an item being counted.
• Subinventory: string
  Maximum Length: 10

  Value that identifies the physical or logical area in the inventory organization where you store material.

{
    "type":"object",
    "properties":{
        "ScheduleStatusCode":{
            "type":"integer",
            "description":"Value that indicates the schedule status. A list of possible values is defined in the lookup type ORA_INV_CC_SCHEDULE_STATUS.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LocatorId":{
            "title":"Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CycleCountScheduleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cycle count schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "CycleCountHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cycle count definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RequestSourceTypeCode":{
            "type":"integer",
            "description":"Value that indicates the manner in which the count schedule was created. A list of possible values is defined in the lookup type INV_CC_APPROVAL_TYPES.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ScheduleDate":{
            "title":"Schedule Date",
            "type":"string",
            "description":"Date when the count was scheduled.",
            "format":"date",
            "nullable":false
        },
        "Locator":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies physical area, such as a row, rack, aisle, bin, or shelf in the subinventory that stores material.",
            "nullable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the inventory item.",
            "nullable":true
        },
        "Revision":{
            "maxLength":18,
            "type":"string",
            "description":"Value that identifies the version of the item.",
            "nullable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies a single quantity of an item being counted.",
            "nullable":true
        },
        "CycleCountName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the cycle count.",
            "nullable":true
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Value that identifies the physical or logical area in the inventory organization where you store material.",
            "nullable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the inventory organization.",
            "nullable":true
        },
        "LotNumber":{
            "title":"Lot",
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies a set of items that are being counted, which are produced together and share the same production costs and specifications.",
            "nullable":true
        },
        "CountZeroQuantityFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then count the locations that contains zero quantity. If false, then do not count the locations that contains zero quantity. The default value is false.",
            "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(required):
  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(required):
  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 : cycleCountSchedules-item-response

Type: object

Show Source

• CountDueDate: string (date)
  Read Only: true

  Date when the count is scheduled to be completed.
• CountZeroQuantityFlag: boolean
  Contains one of the following values: true or false. If true, then count the locations that contains zero quantity. If false, then do not count the locations that contains zero quantity. The default value is false.
• CycleCountHeaderId: integer (int64)
  Value that uniquely identifies the cycle count definition.
• CycleCountName: string
  Maximum Length: 255

  Name of the cycle count.
• CycleCountScheduleId: integer (int64)
  Value that uniquely identifies the cycle count schedule.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item number.
• ItemNumber: string
  Maximum Length: 255

  Number that identifies the inventory item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Locator: string
  Maximum Length: 255

  Value that identifies physical area, such as a row, rack, aisle, bin, or shelf in the subinventory that stores material.
• LocatorId: integer (int64)
  Title: Locator

  Value that uniquely identifies the locator.
• LotNumber: string
  Title: Lot

  Maximum Length: 80

  Number that identifies a set of items that are being counted, which are produced together and share the same production costs and specifications.
• OrganizationCode: string
  Maximum Length: 255

  Value that identifies the inventory organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization.
• RequestSourceType: string
  Read Only: true

  Maximum Length: 255

  Value that determines the manner in which the count schedule was created. A list of possible values is defined in the lookup type INV_CC_APPROVAL_TYPES.
• RequestSourceTypeCode: integer (int64)
  Value that indicates the manner in which the count schedule was created. A list of possible values is defined in the lookup type INV_CC_APPROVAL_TYPES.
• Revision: string
  Maximum Length: 18

  Value that identifies the version of the item.
• ScheduleDate: string (date)
  Title: Schedule Date

  Date when the count was scheduled.
• ScheduleStatus: string
  Read Only: true

  Maximum Length: 255

  Value that determines the schedule status. A list of possible values is defined in the lookup type ORA_INV_CC_SCHEDULE_STATUS.
• ScheduleStatusCode: integer (int64)
  Value that indicates the schedule status. A list of possible values is defined in the lookup type ORA_INV_CC_SCHEDULE_STATUS.
• SerialNumber: string
  Title: Serial Number

  Maximum Length: 80

  Number that identifies a single quantity of an item being counted.
• Subinventory: string
  Maximum Length: 10

  Value that identifies the physical or logical area in the inventory organization where you store material.

{
    "type":"object",
    "properties":{
        "ScheduleStatusCode":{
            "type":"integer",
            "description":"Value that indicates the schedule status. A list of possible values is defined in the lookup type ORA_INV_CC_SCHEDULE_STATUS.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocatorId":{
            "title":"Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CycleCountScheduleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cycle count schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CycleCountHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the cycle count definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestSourceTypeCode":{
            "type":"integer",
            "description":"Value that indicates the manner in which the count schedule was created. A list of possible values is defined in the lookup type INV_CC_APPROVAL_TYPES.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ScheduleDate":{
            "title":"Schedule Date",
            "type":"string",
            "description":"Date when the count was scheduled.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Locator":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies physical area, such as a row, rack, aisle, bin, or shelf in the subinventory that stores material.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the inventory item.",
            "nullable":true,
            "x-queryable":true
        },
        "Revision":{
            "maxLength":18,
            "type":"string",
            "description":"Value that identifies the version of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies a single quantity of an item being counted.",
            "nullable":true,
            "x-queryable":true
        },
        "CountDueDate":{
            "type":"string",
            "description":"Date when the count is scheduled to be completed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CycleCountName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the cycle count.",
            "nullable":true,
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Value that identifies the physical or logical area in the inventory organization where you store material.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequestSourceType":{
            "maxLength":255,
            "type":"string",
            "description":"Value that determines the manner in which the count schedule was created. A list of possible values is defined in the lookup type INV_CC_APPROVAL_TYPES.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScheduleStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Value that determines the schedule status. A list of possible values is defined in the lookup type ORA_INV_CC_SCHEDULE_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LotNumber":{
            "title":"Lot",
            "maxLength":80,
            "type":"string",
            "description":"Number that identifies a set of items that are being counted, which are produced together and share the same production costs and specifications.",
            "nullable":true,
            "x-queryable":true
        },
        "CountZeroQuantityFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then count the locations that contains zero quantity. If false, then do not count the locations that contains zero quantity. The default value is false.",
            "nullable":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

Examples

This example describes how to create one schedule.

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.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/cycleCountSchedules"

Example Request Body

The following example includes the contents of the request body in JSON format. 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.

{ 
 "CycleCountName": "AREST1", 
 "OrganizationCode": "M1", 
 "Subinventory": "SUBPD", 
 "Locator":"1.1.1.1",
 "ScheduleDate": "2018-09-24", 
 "CountZeroQuantityFlag": true 
}

Example Response Body

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

{
    "CycleCountScheduleId": 300100158689789,
    "CycleCountHeaderId": 300100152473866,
    "CycleCountName": null,
    "OrganizationId": 207,
    "OrganizationCode": null,
    "InventoryItemId": null,
    "ItemNumber": null,
    "Subinventory": "SUBPD",
    "LocatorId": 300100152473027,
    "Locator": null,
    "Revision": null,
    "LotNumber": null,
    "SerialNumber": null,
    "ScheduleDate": "2018-09-24",
    "CountZeroQuantityFlag": "true",
    "ScheduleStatusCode": 1,
    "ScheduleStatus": null,
    "CountDueDate": null,
    "RequestSourceTypeCode": 2,
    "RequestSourceType": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/cycleCountSchedules/300100158689789",
            "name": "cycleCountSchedules",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/cycleCountSchedules/300100158689789",
            "name": "cycleCountSchedules",
            "kind": "item"
        }
    ]
}

Back to Top