Jump to

• Request
• Response

Update one planning cycle

patch

/fscmRestApi/resources/11.13.18.05/planningCycles/{PlanningCycleId}

Request

Path Parameters

• PlanningCycleId(required): integer(int64)
  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: string
  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: string
  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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• PlanningCycleDescription: string
  Maximum Length: 100

  Description of the planning cycle.
• PlanningCycleEndDate: string (date)
  Date when the planning cycle ends.
• PlanningCycleOwnerId: string
  Maximum Length: 64

  Value that uniquely identifies who owns the planning cycle.
• planningCyclePlans: array Planning Cycle Plans
  Title: Planning Cycle Plans

  A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans.
• planningCycleStages: array Planning Cycle Stages
  Title: Planning Cycle Stages

  A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process
• PlanningCycleStartDate: string (date)
  Date when the planning cycle starts.
• PlanningCycleStatusCode: integer (int32)
  Status of the planning cycle. Contains one of the following values. 0: Not started, 1: In progress, or 2: Completed.
• planningCycleWorkLists: array Planning Cycle Worklists
  Title: Planning Cycle Worklists

  A worklist is a list of planning tasks that require user action.

{
    "type":"object",
    "properties":{
        "PlanningCycleEndDate":{
            "type":"string",
            "description":"Date when the planning cycle ends.",
            "format":"date",
            "nullable":false
        },
        "PlanningCycleOwnerId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who owns the planning cycle.",
            "nullable":true
        },
        "PlanningCycleDescription":{
            "maxLength":100,
            "type":"string",
            "description":"Description of the planning cycle.",
            "nullable":true
        },
        "PlanningCycleStatusCode":{
            "type":"integer",
            "description":"Status of the planning cycle. Contains one of the following values. 0: Not started, 1: In progress, or 2: Completed.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        },
        "planningCyclePlans":{
            "title":"Planning Cycle Plans",
            "type":"array",
            "description":"A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans.",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCyclePlans-item-patch-request"
            }
        },
        "PlanningCycleStartDate":{
            "type":"string",
            "description":"Date when the planning cycle starts.",
            "format":"date",
            "nullable":false
        },
        "planningCycleStages":{
            "title":"Planning Cycle Stages",
            "type":"array",
            "description":"A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCycleStages-item-patch-request"
            }
        },
        "planningCycleWorkLists":{
            "title":"Planning Cycle Worklists",
            "type":"array",
            "description":"A worklist is a list of planning tasks that require user action.",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCycleWorkLists-item-patch-request"
            }
        }
    }
}

Nested Schema : Planning Cycle Plans

Type: array

Title: Planning Cycle Plans

A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans.

Show Source

• Array of: object planningCycles-planningCyclePlans-item-patch-request

{
    "title":"Planning Cycle Plans",
    "type":"array",
    "description":"A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans.",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCyclePlans-item-patch-request"
    }
}

Nested Schema : Planning Cycle Stages

Type: array

Title: Planning Cycle Stages

A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process

Show Source

• Array of: object schema

{
    "title":"Planning Cycle Stages",
    "type":"array",
    "description":"A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCycleStages-item-patch-request"
    }
}

Nested Schema : Planning Cycle Worklists

Type: array

Title: Planning Cycle Worklists

A worklist is a list of planning tasks that require user action.

Show Source

• Array of: object planningCycles-planningCycleWorkLists-item-patch-request

{
    "title":"Planning Cycle Worklists",
    "type":"array",
    "description":"A worklist is a list of planning tasks that require user action.",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCycleWorkLists-item-patch-request"
    }
}

Nested Schema : planningCycles-planningCyclePlans-item-patch-request

Type: object

Show Source

• PlanningCyclePlansPlanName: string
  Maximum Length: 30

  Name of the plan associated with the planning cycle.

{
    "type":"object",
    "properties":{
        "PlanningCyclePlansPlanName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the plan associated with the planning cycle.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• planningCycleActionDecisionItems: array Action and Decision Items
  Title: Action and Decision Items

  An action item is an unplanned task assigned in a planning cycle stage. A decision item is a recommendation or an alternative to consider during a review stage meeting.
• planningCycleActivities: array Activities
  Title: Activities

  An activity is a group of related planning tasks in a planning cycle stage.
• planningCycleParticipants: array Participants
  Title: Participants

  A group of users to assign tasks as owners and assignees in a planning cycle stage.
• PlanningCycleStageDisplayOrder: integer (int32)
  Value that indicates the display order of the stage in the planning cycle.
• PlanningCycleStageName: string
  Maximum Length: 256

  Name of the planning cycle stage.

{
    "type":"object",
    "properties":{
        "PlanningCycleStageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the planning cycle stage.",
            "nullable":false
        },
        "planningCycleActivities":{
            "title":"Activities",
            "type":"array",
            "description":"An activity is a group of related planning tasks in a planning cycle stage.",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleActivities-item-patch-request"
            }
        },
        "PlanningCycleStageDisplayOrder":{
            "type":"integer",
            "description":"Value that indicates the display order of the stage in the planning cycle.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            }
        },
        "planningCycleActionDecisionItems":{
            "title":"Action and Decision Items",
            "type":"array",
            "description":"An action item is an unplanned task assigned in a planning cycle stage. A decision item is a recommendation or an alternative to consider during a review stage meeting.",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleActionDecisionItems-item-patch-request"
            }
        },
        "planningCycleParticipants":{
            "title":"Participants",
            "type":"array",
            "description":"A group of users to assign tasks as owners and assignees in a planning cycle stage.",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleParticipants-item-patch-request"
            }
        }
    }
}

Nested Schema : Action and Decision Items

Type: array

Title: Action and Decision Items

An action item is an unplanned task assigned in a planning cycle stage. A decision item is a recommendation or an alternative to consider during a review stage meeting.

Show Source

• Array of: object schema

{
    "title":"Action and Decision Items",
    "type":"array",
    "description":"An action item is an unplanned task assigned in a planning cycle stage. A decision item is a recommendation or an alternative to consider during a review stage meeting.",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleActionDecisionItems-item-patch-request"
    }
}

Nested Schema : Activities

Type: array

Title: Activities

An activity is a group of related planning tasks in a planning cycle stage.

Show Source

• Array of: object schema

{
    "title":"Activities",
    "type":"array",
    "description":"An activity is a group of related planning tasks in a planning cycle stage.",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleActivities-item-patch-request"
    }
}

Nested Schema : Participants

Type: array

Title: Participants

A group of users to assign tasks as owners and assignees in a planning cycle stage.

Show Source

• Array of: object planningCycles-planningCycleStages-planningCycleParticipants-item-patch-request

{
    "title":"Participants",
    "type":"array",
    "description":"A group of users to assign tasks as owners and assignees in a planning cycle stage.",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleParticipants-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• PlanningCycleTaskAssigneeId: string
  Maximum Length: 64

  Value that uniquely identifies who's assigned the action and decision item in the planning cycle stage.
• PlanningCycleTaskComments: string
  Maximum Length: 1000

  Description of the planning cycle.
• PlanningCycleTaskCompletionDate: string (date)
  Date when the action and decision item in the planning cycle stage is completed.
• PlanningCycleTaskDueDate: string (date)
  Date when the action and decision item in the planning cycle stage is due.
• PlanningCycleTaskId: integer (int64)
  Value that uniquely identifies the action and decision item in the planning cycle stage.
• PlanningCycleTaskLink: string
  Maximum Length: 256

  Name of the report link associated with the action and decision item in the planning cycle stage.
• PlanningCycleTaskLinkId: integer (int64)
  Value that uniquely identifies the report link associated with the action and decision item in the planning cycle stage.
• PlanningCycleTaskLinkType: integer (int32)
  Type of report link associated with the action and decision item task in the planning cycle stage. A valid value includes 2 for page group.
• PlanningCycleTaskOffSetDays: integer (int64)
  Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.
• PlanningCycleTaskOwnerId: string
  Maximum Length: 64

  Value that uniquely identifies who owns the action and decision item in the planning cycle stage.
• PlanningCycleTaskStageId: integer (int64)
  Value that uniquely identifies the planning cycle stage associated with the action and decision item.
• PlanningCycleTaskStatusCode: string
  Maximum Length: 32

  Status of the action and decision item in the planning cycle stage. A list of valid values for the action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid values for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS.
• PlanningCycleTaskTitle: string
  Maximum Length: 100

  Name of the action and decision item in the planning cycle stage.
• PlanningCycleTaskTypeCode: string
  Maximum Length: 64

  Type of action and decision item in the planning cycle stage. Contains one of the following values. 1: Action or 2: Decision.

{
    "type":"object",
    "properties":{
        "PlanningCycleTaskTypeCode":{
            "maxLength":64,
            "type":"string",
            "description":"Type of action and decision item in the planning cycle stage. Contains one of the following values. 1: Action or 2: Decision.",
            "nullable":true
        },
        "PlanningCycleTaskAssigneeId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who's assigned the action and decision item in the planning cycle stage.",
            "nullable":true
        },
        "PlanningCycleTaskComments":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the planning cycle.",
            "nullable":true
        },
        "PlanningCycleTaskDueDate":{
            "type":"string",
            "description":"Date when the action and decision item in the planning cycle stage is due.",
            "format":"date",
            "nullable":true
        },
        "PlanningCycleTaskTitle":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the action and decision item in the planning cycle stage.",
            "nullable":false
        },
        "PlanningCycleTaskLink":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the report link associated with the action and decision item in the planning cycle stage.",
            "nullable":true
        },
        "PlanningCycleTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the action and decision item in the planning cycle stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleTaskOffSetDays":{
            "type":"integer",
            "description":"Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleTaskLinkId":{
            "type":"integer",
            "description":"Value that uniquely identifies the report link associated with the action and decision item in the planning cycle stage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleTaskStageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle stage associated with the action and decision item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleTaskCompletionDate":{
            "type":"string",
            "description":"Date when the action and decision item in the planning cycle stage is completed.",
            "format":"date",
            "nullable":true
        },
        "PlanningCycleTaskStatusCode":{
            "maxLength":32,
            "type":"string",
            "description":"Status of the action and decision item in the planning cycle stage. A list of valid values for the action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid values for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS.",
            "nullable":true
        },
        "PlanningCycleTaskLinkType":{
            "type":"integer",
            "description":"Type of report link associated with the action and decision item task in the planning cycle stage. A valid value includes 2 for page group.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "PlanningCycleTaskOwnerId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who owns the action and decision item in the planning cycle stage.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• PlanningCycleActivityAssigneeId: string
  Maximum Length: 64

  Value that uniquely identifies who's assigned the activity in the planning cycle stage.
• PlanningCycleActivityCompletionDate: string (date)
  Date when the activity in the planning cycle stage is completed.
• PlanningCycleActivityDescription: string
  Maximum Length: 256

  Description of the activity in the planning cycle stage.
• PlanningCycleActivityDisplayOrder(required): integer (int64)
  Value that indicates the display order of the activity in the planning cycle stage.
• PlanningCycleActivityDueDate: string (date)
  Date when the activity in the planning cycle stage is due.
• PlanningCycleActivityId: integer (int64)
  Value that uniquely identifies the activity in the planning cycle stage.
• PlanningCycleActivityLink: string
  Maximum Length: 256

  Name of the report link associated with the activity in the planning cycle stage.
• PlanningCycleActivityLinkId: integer (int64)
  Value that uniquely identifies the report link associated with the activity in the planning cycle stage.
• PlanningCycleActivityLinkType: integer (int32)
  Type of report link associated with the activity in the planning cycle stage. A valid value includes 2 for page group.
• PlanningCycleActivityName(required): string
  Maximum Length: 256

  Name of the activity in the planning cycle stage.
• PlanningCycleActivityOwnerId: string
  Maximum Length: 64

  Value that uniquely identifies who owns the activity in the planning cycle stage.
• PlanningCycleActivityStageId: integer (int64)
  Value that uniquely identifies the planning cycle stage associated with the activity.
• PlanningCycleActivityStatusCode: string
  Maximum Length: 32

  Status of the activity in the planning cycle stage derived from its tasks. A list of valid values for the activity is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.
• PlanningCycleActivityType: string
  Maximum Length: 80

  Name of the type of activity in the planning cycle stage. A list of valid names for the activity is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• PlanningCycleActivityTypeCode: string
  Maximum Length: 64

  Type of activity in the planning cycle stage. A list of valid values for the activity is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• planningCycleTasks: array Tasks
  Title: Tasks

  A recurring task that has an owner and an assignee in a planning cycle stage.

{
    "required":[
        "PlanningCycleActivityDisplayOrder",
        "PlanningCycleActivityName"
    ],
    "type":"object",
    "properties":{
        "PlanningCycleActivityLinkId":{
            "type":"integer",
            "description":"Value that uniquely identifies the report link associated with the activity in the planning cycle stage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleActivityDescription":{
            "maxLength":256,
            "type":"string",
            "description":"Description of the activity in the planning cycle stage.",
            "nullable":true
        },
        "PlanningCycleActivityOwnerId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who owns the activity in the planning cycle stage.",
            "nullable":true
        },
        "PlanningCycleActivityStatusCode":{
            "maxLength":32,
            "type":"string",
            "description":"Status of the activity in the planning cycle stage derived from its tasks. A list of valid values for the activity is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.",
            "nullable":true
        },
        "PlanningCycleActivityName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the activity in the planning cycle stage.",
            "nullable":false
        },
        "PlanningCycleActivityDisplayOrder":{
            "type":"integer",
            "description":"Value that indicates the display order of the activity in the planning cycle stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleActivityTypeCode":{
            "maxLength":64,
            "type":"string",
            "description":"Type of activity in the planning cycle stage. A list of valid values for the activity is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true
        },
        "PlanningCycleActivityLink":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the report link associated with the activity in the planning cycle stage.",
            "nullable":true
        },
        "PlanningCycleActivityStageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle stage associated with the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleActivityLinkType":{
            "type":"integer",
            "description":"Type of report link associated with the activity in the planning cycle stage. A valid value includes 2 for page group.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "PlanningCycleActivityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the activity in the planning cycle stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleActivityType":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the type of activity in the planning cycle stage. A list of valid names for the activity is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true
        },
        "PlanningCycleActivityAssigneeId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who's assigned the activity in the planning cycle stage.",
            "nullable":true
        },
        "PlanningCycleActivityDueDate":{
            "type":"string",
            "description":"Date when the activity in the planning cycle stage is due.",
            "format":"date",
            "nullable":true
        },
        "PlanningCycleActivityCompletionDate":{
            "type":"string",
            "description":"Date when the activity in the planning cycle stage is completed.",
            "format":"date",
            "nullable":true
        },
        "planningCycleTasks":{
            "title":"Tasks",
            "type":"array",
            "description":"A recurring task that has an owner and an assignee in a planning cycle stage.",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleActivities-planningCycleTasks-item-patch-request"
            }
        }
    }
}

Nested Schema : Tasks

Type: array

Title: Tasks

A recurring task that has an owner and an assignee in a planning cycle stage.

Show Source

• Array of: object planningCycles-planningCycleStages-planningCycleActivities-planningCycleTasks-item-patch-request

{
    "title":"Tasks",
    "type":"array",
    "description":"A recurring task that has an owner and an assignee in a planning cycle stage.",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleActivities-planningCycleTasks-item-patch-request"
    }
}

Nested Schema : planningCycles-planningCycleStages-planningCycleActivities-planningCycleTasks-item-patch-request

Type: object

Show Source

• PlanningCycleTaskAssigneeId: string
  Maximum Length: 64

  Value that uniquely identifies who's assigned the task in the planning cycle stage.
• PlanningCycleTaskCompletionDate: string (date)
  Date when the task in the planning cycle stage is completed.
• PlanningCycleTaskDueDate: string (date)
  Date when the task in the planning cycle stage is due.
• PlanningCycleTaskId: integer (int64)
  Value that uniquely identifies the task in the planning cycle stage.
• PlanningCycleTaskLinkId: integer (int64)
  Value that uniquely identifies the report link associated with the task in the planning cycle stage.
• PlanningCycleTaskLinktype: integer (int32)
  Type of report link associated with the task in the planning cycle stage. A valid value includes 2 for page group.
• PlanningCycleTaskOffSetDays: integer (int64)
  Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.
• PlanningCycleTaskOwnerId: string
  Maximum Length: 64

  Value that uniquely identifies who owns the task in the planning cycle stage.
• PlanningCycleTaskStageId: integer (int64)
  Value that uniquely identifies the planning cycle stage associated with the task.
• PlanningCycleTaskStatusCode: string
  Maximum Length: 32

  Status of the task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.
• PlanningCycleTaskTitle: string
  Maximum Length: 100

  Name of the task in the planning cycle stage.
• PlanningCycleTaskType: string
  Maximum Length: 80

  Name of the type of task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• PlanningCycleTaskTypeCode: string
  Maximum Length: 64

  Type of task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• PlannningCycleTaskLink: string
  Maximum Length: 256

  Name of the report link associated with the task in the planning cycle stage.

{
    "type":"object",
    "properties":{
        "PlanningCycleTaskTypeCode":{
            "maxLength":64,
            "type":"string",
            "description":"Type of task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true
        },
        "PlanningCycleTaskAssigneeId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who's assigned the task in the planning cycle stage.",
            "nullable":true
        },
        "PlanningCycleTaskDueDate":{
            "type":"string",
            "description":"Date when the task in the planning cycle stage is due.",
            "format":"date",
            "nullable":true
        },
        "PlanningCycleTaskLinktype":{
            "type":"integer",
            "description":"Type of report link associated with the task in the planning cycle stage. A valid value includes 2 for page group.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            }
        },
        "PlanningCycleTaskTitle":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the task in the planning cycle stage.",
            "nullable":false
        },
        "PlanningCycleTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task in the planning cycle stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleTaskOffSetDays":{
            "type":"integer",
            "description":"Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleTaskLinkId":{
            "type":"integer",
            "description":"Value that uniquely identifies the report link associated with the task in the planning cycle stage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleTaskStageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle stage associated with the task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleTaskType":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the type of task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true
        },
        "PlanningCycleTaskCompletionDate":{
            "type":"string",
            "description":"Date when the task in the planning cycle stage is completed.",
            "format":"date",
            "nullable":true
        },
        "PlanningCycleTaskStatusCode":{
            "maxLength":32,
            "type":"string",
            "description":"Status of the task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.",
            "nullable":true
        },
        "PlanningCycleTaskOwnerId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who owns the task in the planning cycle stage.",
            "nullable":true
        },
        "PlannningCycleTaskLink":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the report link associated with the task in the planning cycle stage.",
            "nullable":true
        }
    }
}

Nested Schema : planningCycles-planningCycleStages-planningCycleParticipants-item-patch-request

Type: object

Show Source

• PlanningCycleId: integer (int64)
  Value that uniquely identifies the planning cycle in which the user is a participant.
• PlanningCycleParticipantId: string
  Maximum Length: 64

  Value that uniquely identifies the user who's a participant in the planning cycle stage.
• PlanningCycleParticipantsStageId: integer (int64)
  Value that uniquely identifies the planning cycle stage in which the user is a participant.

{
    "type":"object",
    "properties":{
        "PlanningCycleParticipantsStageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle stage in which the user is a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PlanningCycleParticipantId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies the user who's a participant in the planning cycle stage.",
            "nullable":false
        },
        "PlanningCycleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle in which the user is a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : planningCycles-planningCycleWorkLists-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the planning cycle.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the planning cycle.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the planning cycle.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningCycleDescription: string
  Maximum Length: 100

  Description of the planning cycle.
• PlanningCycleEndDate: string (date)
  Date when the planning cycle ends.
• PlanningCycleId: integer (int64)
  Value that uniquely identifies the planning cycle.
• PlanningCycleName: string
  Maximum Length: 100

  Name of the planning cycle.
• PlanningCycleOwner: string
  Read Only: true

  Maximum Length: 255

  Name of the user who owns the planning cycle.
• PlanningCycleOwnerId: string
  Maximum Length: 64

  Value that uniquely identifies who owns the planning cycle.
• planningCyclePlans: array Planning Cycle Plans
  Title: Planning Cycle Plans

  A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans.
• PlanningCyclePlansDetail: string
  Read Only: true

  Maximum Length: 4000

  List of plans associated with the planning cycle. A comma separates each value. Values display in the following sequence with a colon between them: Plan name and Plan Id.
• planningCycleStages: array Planning Cycle Stages
  Title: Planning Cycle Stages

  A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process
• PlanningCycleStagesDetail: string
  Read Only: true

  Maximum Length: 4000

  List of stages in the planning cycle. A comma separates each value. Values display in the following sequence with a colon between them: Stage Name and Display Order.
• PlanningCycleStartDate: string (date)
  Date when the planning cycle starts.
• PlanningCycleStatus: string
  Read Only: true

  Maximum Length: 255

  Status name of the planning cycle. Contains one of the following names. Not started, In progress, or Completed.
• PlanningCycleStatusCode: integer (int32)
  Status of the planning cycle. Contains one of the following values. 0: Not started, 1: In progress, or 2: Completed.
• planningCycleWorkLists: array Planning Cycle Worklists
  Title: Planning Cycle Worklists

  A worklist is a list of planning tasks that require user action.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the planning cycle.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleEndDate":{
            "type":"string",
            "description":"Date when the planning cycle ends.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the planning cycle.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the planning cycle.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleStatusCode":{
            "type":"integer",
            "description":"Status of the planning cycle. Contains one of the following values. 0: Not started, 1: In progress, or 2: Completed.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "PlanningCycleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "planningCyclePlans":{
            "title":"Planning Cycle Plans",
            "type":"array",
            "description":"A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans.",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCyclePlans-item-response"
            }
        },
        "PlanningCycleOwner":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who owns the planning cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleStartDate":{
            "type":"string",
            "description":"Date when the planning cycle starts.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "planningCycleStages":{
            "title":"Planning Cycle Stages",
            "type":"array",
            "description":"A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCycleStages-item-response"
            }
        },
        "PlanningCycleStatus":{
            "maxLength":255,
            "type":"string",
            "description":"Status name of the planning cycle. Contains one of the following names. Not started, In progress, or Completed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleOwnerId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who owns the planning cycle.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleDescription":{
            "maxLength":100,
            "type":"string",
            "description":"Description of the planning cycle.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCyclePlansDetail":{
            "maxLength":4000,
            "type":"string",
            "description":"List of plans associated with the planning cycle. A comma separates each value. Values display in the following sequence with a colon between them: Plan name and Plan Id.",
            "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"
            }
        },
        "PlanningCycleName":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the planning cycle.",
            "nullable":false,
            "x-queryable":true
        },
        "planningCycleWorkLists":{
            "title":"Planning Cycle Worklists",
            "type":"array",
            "description":"A worklist is a list of planning tasks that require user action.",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCycleWorkLists-item-response"
            }
        },
        "PlanningCycleStagesDetail":{
            "maxLength":4000,
            "type":"string",
            "description":"List of stages in the planning cycle. A comma separates each value. Values display in the following sequence with a colon between them: Stage Name and Display Order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the planning cycle.",
            "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 : Planning Cycle Plans

Type: array

Title: Planning Cycle Plans

A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans.

Show Source

• Array of: object planningCycles-planningCyclePlans-item-response

{
    "title":"Planning Cycle Plans",
    "type":"array",
    "description":"A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans.",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCyclePlans-item-response"
    }
}

Nested Schema : Planning Cycle Stages

Type: array

Title: Planning Cycle Stages

A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process

Show Source

• Array of: object planningCycles-planningCycleStages-item-response

{
    "title":"Planning Cycle Stages",
    "type":"array",
    "description":"A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCycleStages-item-response"
    }
}

Nested Schema : Planning Cycle Worklists

Type: array

Title: Planning Cycle Worklists

A worklist is a list of planning tasks that require user action.

Show Source

• Array of: object planningCycles-planningCycleWorkLists-item-response

{
    "title":"Planning Cycle Worklists",
    "type":"array",
    "description":"A worklist is a list of planning tasks that require user action.",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCycleWorkLists-item-response"
    }
}

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 : planningCycles-planningCyclePlans-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who added the plan to the planning cycle stage.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user added the plan to the planning cycle stage.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the plan in the planning cycle stage.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the plan in the planning cycle stage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningCycleId: integer (int64)
  Value that uniquely identifies the planning cycle associated with the plan.
• PlanningCyclePlansPlanId: integer (int64)
  Value that uniquely identifies the plan associated with the planning cycle.
• PlanningCyclePlansPlanName: string
  Maximum Length: 30

  Name of the plan associated with the planning cycle.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the plan in the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user added the plan to the planning cycle stage.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who added the plan to the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle associated with the plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanningCyclePlansPlanName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the plan associated with the planning cycle.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCyclePlansPlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan associated with the planning cycle.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the plan in the planning cycle stage.",
            "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 : planningCycles-planningCycleStages-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the planning cycle stage.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the planning cycle stage.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the planning cycle stage.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the planning cycle stage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• planningCycleActionDecisionItems: array Action and Decision Items
  Title: Action and Decision Items

  An action item is an unplanned task assigned in a planning cycle stage. A decision item is a recommendation or an alternative to consider during a review stage meeting.
• planningCycleActivities: array Activities
  Title: Activities

  An activity is a group of related planning tasks in a planning cycle stage.
• PlanningCycleId: integer (int64)
  Value that uniquely identifies the planning cycle.
• planningCycleParticipants: array Participants
  Title: Participants

  A group of users to assign tasks as owners and assignees in a planning cycle stage.
• PlanningCycleStageDisplayOrder: integer (int32)
  Value that indicates the display order of the stage in the planning cycle.
• PlanningCycleStageId: integer (int64)
  Value that uniquely identifies the planning cycle stage.
• PlanningCycleStageName: string
  Maximum Length: 256

  Name of the planning cycle stage.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the planning cycle stage.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleStageDisplayOrder":{
            "type":"integer",
            "description":"Value that indicates the display order of the stage in the planning cycle.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "planningCycleActionDecisionItems":{
            "title":"Action and Decision Items",
            "type":"array",
            "description":"An action item is an unplanned task assigned in a planning cycle stage. A decision item is a recommendation or an alternative to consider during a review stage meeting.",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleActionDecisionItems-item-response"
            }
        },
        "planningCycleParticipants":{
            "title":"Participants",
            "type":"array",
            "description":"A group of users to assign tasks as owners and assignees in a planning cycle stage.",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleParticipants-item-response"
            }
        },
        "PlanningCycleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleStageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the planning cycle stage.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanningCycleStageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "planningCycleActivities":{
            "title":"Activities",
            "type":"array",
            "description":"An activity is a group of related planning tasks in a planning cycle stage.",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleActivities-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the planning cycle stage.",
            "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 : Action and Decision Items

Type: array

Title: Action and Decision Items

An action item is an unplanned task assigned in a planning cycle stage. A decision item is a recommendation or an alternative to consider during a review stage meeting.

Show Source

• Array of: object planningCycles-planningCycleStages-planningCycleActionDecisionItems-item-response

{
    "title":"Action and Decision Items",
    "type":"array",
    "description":"An action item is an unplanned task assigned in a planning cycle stage. A decision item is a recommendation or an alternative to consider during a review stage meeting.",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleActionDecisionItems-item-response"
    }
}

Nested Schema : Activities

Type: array

Title: Activities

An activity is a group of related planning tasks in a planning cycle stage.

Show Source

• Array of: object planningCycles-planningCycleStages-planningCycleActivities-item-response

{
    "title":"Activities",
    "type":"array",
    "description":"An activity is a group of related planning tasks in a planning cycle stage.",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleActivities-item-response"
    }
}

Nested Schema : Participants

Type: array

Title: Participants

A group of users to assign tasks as owners and assignees in a planning cycle stage.

Show Source

• Array of: object planningCycles-planningCycleStages-planningCycleParticipants-item-response

{
    "title":"Participants",
    "type":"array",
    "description":"A group of users to assign tasks as owners and assignees in a planning cycle stage.",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleParticipants-item-response"
    }
}

Nested Schema : planningCycles-planningCycleStages-planningCycleActionDecisionItems-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the action and decision item in the planning cycle stage.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the action and decision item in the planning cycle stage.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the action and decision item in the planning cycle stage.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the action and decision item in the planning cycle stage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningCycleTaskAssignee: string
  Read Only: true

  Maximum Length: 255

  Name of the user who's assigned the action and decision item in the planning cycle stage.
• PlanningCycleTaskAssigneeId: string
  Maximum Length: 64

  Value that uniquely identifies who's assigned the action and decision item in the planning cycle stage.
• PlanningCycleTaskComments: string
  Maximum Length: 1000

  Description of the planning cycle.
• PlanningCycleTaskCompletionDate: string (date)
  Date when the action and decision item in the planning cycle stage is completed.
• PlanningCycleTaskDaysLate: integer
  Read Only: true

  Value that indicates the difference between the completion date and the due date for the action and decision item in the planning cycle stage.
• PlanningCycleTaskDueDate: string (date)
  Date when the action and decision item in the planning cycle stage is due.
• PlanningCycleTaskId: integer (int64)
  Value that uniquely identifies the action and decision item in the planning cycle stage.
• PlanningCycleTaskLink: string
  Maximum Length: 256

  Name of the report link associated with the action and decision item in the planning cycle stage.
• PlanningCycleTaskLinkId: integer (int64)
  Value that uniquely identifies the report link associated with the action and decision item in the planning cycle stage.
• PlanningCycleTaskLinkType: integer (int32)
  Type of report link associated with the action and decision item task in the planning cycle stage. A valid value includes 2 for page group.
• PlanningCycleTaskOffSetDays: integer (int64)
  Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.
• PlanningCycleTaskOwner: string
  Read Only: true

  Maximum Length: 255

  Name of the user who owns the action and decision item in the planning cycle stage.
• PlanningCycleTaskOwnerId: string
  Maximum Length: 64

  Value that uniquely identifies who owns the action and decision item in the planning cycle stage.
• PlanningCycleTaskStageId: integer (int64)
  Value that uniquely identifies the planning cycle stage associated with the action and decision item.
• PlanningCycleTaskStageName: string
  Read Only: true

  Maximum Length: 256

  Name of the planning cycle stage associated with the action and decision item.
• PlanningCycleTaskStatus: string
  Read Only: true

  Maximum Length: 80

  Status name of the action and decision item in the planning cycle stage. A list of valid names for the action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid status names for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS.
• PlanningCycleTaskStatusCode: string
  Maximum Length: 32

  Status of the action and decision item in the planning cycle stage. A list of valid values for the action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid values for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS.
• PlanningCycleTaskTitle: string
  Maximum Length: 100

  Name of the action and decision item in the planning cycle stage.
• PlanningCycleTaskType: string
  Read Only: true

  Maximum Length: 80

  Name of the type of action and decision item in the planning cycle stage. Contains one of the following names. Action or Decision.
• PlanningCycleTaskTypeCode: string
  Maximum Length: 64

  Type of action and decision item in the planning cycle stage. Contains one of the following values. 1: Action or 2: Decision.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the action and decision item in the planning cycle stage.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskTitle":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the action and decision item in the planning cycle stage.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanningCycleTaskLink":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the report link associated with the action and decision item in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the action and decision item in the planning cycle stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleTaskOffSetDays":{
            "type":"integer",
            "description":"Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleTaskStageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle stage associated with the action and decision item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleTaskType":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the type of action and decision item in the planning cycle stage. Contains one of the following names. Action or Decision.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskStatusCode":{
            "maxLength":32,
            "type":"string",
            "description":"Status of the action and decision item in the planning cycle stage. A list of valid values for the action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid values for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskLinkType":{
            "type":"integer",
            "description":"Type of report link associated with the action and decision item task in the planning cycle stage. A valid value includes 2 for page group.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanningCycleTaskDaysLate":{
            "type":"integer",
            "description":"Value that indicates the difference between the completion date and the due date for the action and decision item in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskOwnerId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who owns the action and decision item in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskAssignee":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who's assigned the action and decision item in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the action and decision item in the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskTypeCode":{
            "maxLength":64,
            "type":"string",
            "description":"Type of action and decision item in the planning cycle stage. Contains one of the following values. 1: Action or 2: Decision.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskOwner":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who owns the action and decision item in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the action and decision item in the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskAssigneeId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who's assigned the action and decision item in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskComments":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the planning cycle.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskDueDate":{
            "type":"string",
            "description":"Date when the action and decision item in the planning cycle stage is due.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskStageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the planning cycle stage associated with the action and decision item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskLinkId":{
            "type":"integer",
            "description":"Value that uniquely identifies the report link associated with the action and decision item in the planning cycle stage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleTaskCompletionDate":{
            "type":"string",
            "description":"Date when the action and decision item in the planning cycle stage is completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Status name of the action and decision item in the planning cycle stage. A list of valid names for the action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid status names for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the action and decision item in the planning cycle stage.",
            "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 : planningCycles-planningCycleStages-planningCycleActivities-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the activity in the planning cycle stage.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the activity in the planning cycle stage.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the activity in the planning cycle stage.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the activity in the planning cycle stage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningCycleActivityAssigneeId: string
  Maximum Length: 64

  Value that uniquely identifies who's assigned the activity in the planning cycle stage.
• PlanningCycleActivityAssigneeName: string
  Read Only: true

  Maximum Length: 255

  Name of the user who's assigned the activity in the planning cycle stage.
• PlanningCycleActivityCompletionDate: string (date)
  Date when the activity in the planning cycle stage is completed.
• PlanningCycleActivityDaysLate: integer
  Read Only: true

  Value that indicates the difference between the completion date and the due date for the activity in the planning cycle stage.
• PlanningCycleActivityDescription: string
  Maximum Length: 256

  Description of the activity in the planning cycle stage.
• PlanningCycleActivityDisplayOrder: integer (int64)
  Value that indicates the display order of the activity in the planning cycle stage.
• PlanningCycleActivityDueDate: string (date)
  Date when the activity in the planning cycle stage is due.
• PlanningCycleActivityId: integer (int64)
  Value that uniquely identifies the activity in the planning cycle stage.
• PlanningCycleActivityLink: string
  Maximum Length: 256

  Name of the report link associated with the activity in the planning cycle stage.
• PlanningCycleActivityLinkId: integer (int64)
  Value that uniquely identifies the report link associated with the activity in the planning cycle stage.
• PlanningCycleActivityLinkType: integer (int32)
  Type of report link associated with the activity in the planning cycle stage. A valid value includes 2 for page group.
• PlanningCycleActivityName: string
  Maximum Length: 256

  Name of the activity in the planning cycle stage.
• PlanningCycleActivityOwnerId: string
  Maximum Length: 64

  Value that uniquely identifies who owns the activity in the planning cycle stage.
• PlanningCycleActivityOwnerName: string
  Read Only: true

  Maximum Length: 255

  Name of the user who owns the activity in the planning cycle stage.
• PlanningCycleActivityStageId: integer (int64)
  Value that uniquely identifies the planning cycle stage associated with the activity.
• PlanningCycleActivityStageName: string
  Read Only: true

  Maximum Length: 256

  Name of the planning cycle stage associated with the activity.
• PlanningCycleActivityStatus: string
  Read Only: true

  Maximum Length: 80

  Status name of the activity in the planning cycle stage derived from its tasks. A list of valid names for the activity is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.
• PlanningCycleActivityStatusCode: string
  Maximum Length: 32

  Status of the activity in the planning cycle stage derived from its tasks. A list of valid values for the activity is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.
• PlanningCycleActivityType: string
  Maximum Length: 80

  Name of the type of activity in the planning cycle stage. A list of valid names for the activity is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• PlanningCycleActivityTypeCode: string
  Maximum Length: 64

  Type of activity in the planning cycle stage. A list of valid values for the activity is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• planningCycleTasks: array Tasks
  Title: Tasks

  A recurring task that has an owner and an assignee in a planning cycle stage.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the activity in the planning cycle stage.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleActivityOwnerId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who owns the activity in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleActivityDisplayOrder":{
            "type":"integer",
            "description":"Value that indicates the display order of the activity in the planning cycle stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleActivityAssigneeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who's assigned the activity in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleActivityTypeCode":{
            "maxLength":64,
            "type":"string",
            "description":"Type of activity in the planning cycle stage. A list of valid values for the activity is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleActivityLink":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the report link associated with the activity in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanningCycleActivityType":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the type of activity in the planning cycle stage. A list of valid names for the activity is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleActivityDueDate":{
            "type":"string",
            "description":"Date when the activity in the planning cycle stage is due.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "planningCycleTasks":{
            "title":"Tasks",
            "type":"array",
            "description":"A recurring task that has an owner and an assignee in a planning cycle stage.",
            "items":{
                "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleActivities-planningCycleTasks-item-response"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the activity in the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleActivityLinkId":{
            "type":"integer",
            "description":"Value that uniquely identifies the report link associated with the activity in the planning cycle stage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the activity in the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleActivityDescription":{
            "maxLength":256,
            "type":"string",
            "description":"Description of the activity in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleActivityStatusCode":{
            "maxLength":32,
            "type":"string",
            "description":"Status of the activity in the planning cycle stage derived from its tasks. A list of valid values for the activity is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleActivityName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the activity in the planning cycle stage.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanningCycleActivityStageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle stage associated with the activity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleActivityStageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the planning cycle stage associated with the activity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleActivityLinkType":{
            "type":"integer",
            "description":"Type of report link associated with the activity in the planning cycle stage. A valid value includes 2 for page group.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlanningCycleActivityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the activity in the planning cycle stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleActivityAssigneeId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who's assigned the activity in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleActivityDaysLate":{
            "type":"integer",
            "description":"Value that indicates the difference between the completion date and the due date for the activity in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleActivityStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Status name of the activity in the planning cycle stage derived from its tasks. A list of valid names for the activity is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleActivityCompletionDate":{
            "type":"string",
            "description":"Date when the activity in the planning cycle stage is completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleActivityOwnerName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who owns the activity in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the activity in the planning cycle stage.",
            "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 : Tasks

Type: array

Title: Tasks

A recurring task that has an owner and an assignee in a planning cycle stage.

Show Source

• Array of: object planningCycles-planningCycleStages-planningCycleActivities-planningCycleTasks-item-response

{
    "title":"Tasks",
    "type":"array",
    "description":"A recurring task that has an owner and an assignee in a planning cycle stage.",
    "items":{
        "$ref":"#/components/schemas/planningCycles-planningCycleStages-planningCycleActivities-planningCycleTasks-item-response"
    }
}

Nested Schema : planningCycles-planningCycleStages-planningCycleActivities-planningCycleTasks-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the task in the planning cycle stage.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the task in the planning cycle stage.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the task in the planning cycle stage.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the task in the planning cycle stage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningCycleTaskAssignee: string
  Read Only: true

  Maximum Length: 255

  Name of the user who's assigned the task in the planning cycle stage.
• PlanningCycleTaskAssigneeId: string
  Maximum Length: 64

  Value that uniquely identifies who's assigned the task in the planning cycle stage.
• PlanningCycleTaskCompletionDate: string (date)
  Date when the task in the planning cycle stage is completed.
• PlanningCycleTaskDaysLate: integer
  Read Only: true

  Value that indicates the difference between the completion date and the due date for the task in the planning cycle stage.
• PlanningCycleTaskDueDate: string (date)
  Date when the task in the planning cycle stage is due.
• PlanningCycleTaskId: integer (int64)
  Value that uniquely identifies the task in the planning cycle stage.
• PlanningCycleTaskLinkId: integer (int64)
  Value that uniquely identifies the report link associated with the task in the planning cycle stage.
• PlanningCycleTaskLinktype: integer (int32)
  Type of report link associated with the task in the planning cycle stage. A valid value includes 2 for page group.
• PlanningCycleTaskOffSetDays: integer (int64)
  Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.
• PlanningCycleTaskOwner: string
  Read Only: true

  Maximum Length: 255

  Name of the user who owns the task in the planning cycle stage.
• PlanningCycleTaskOwnerId: string
  Maximum Length: 64

  Value that uniquely identifies who owns the task in the planning cycle stage.
• PlanningCycleTaskStageId: integer (int64)
  Value that uniquely identifies the planning cycle stage associated with the task.
• PlanningCycleTaskStageName: string
  Read Only: true

  Maximum Length: 256

  Name of the planning cycle stage associated with the task.
• PlanningCycleTaskStatus: string
  Read Only: true

  Maximum Length: 80

  Status name of the task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.
• PlanningCycleTaskStatusCode: string
  Maximum Length: 32

  Status of the task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.
• PlanningCycleTaskTitle: string
  Maximum Length: 100

  Name of the task in the planning cycle stage.
• PlanningCycleTaskType: string
  Maximum Length: 80

  Name of the type of task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• PlanningCycleTaskTypeCode: string
  Maximum Length: 64

  Type of task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• PlannningCycleTaskLink: string
  Maximum Length: 256

  Name of the report link associated with the task in the planning cycle stage.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the task in the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the task in the planning cycle stage.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskTypeCode":{
            "maxLength":64,
            "type":"string",
            "description":"Type of task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskOwner":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who owns the task in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the task in the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskAssigneeId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who's assigned the task in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskDueDate":{
            "type":"string",
            "description":"Date when the task in the planning cycle stage is due.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskLinktype":{
            "type":"integer",
            "description":"Type of report link associated with the task in the planning cycle stage. A valid value includes 2 for page group.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PlanningCycleTaskStageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the planning cycle stage associated with the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskTitle":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the task in the planning cycle stage.",
            "nullable":false,
            "x-queryable":true
        },
        "PlanningCycleTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task in the planning cycle stage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleTaskOffSetDays":{
            "type":"integer",
            "description":"Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleTaskLinkId":{
            "type":"integer",
            "description":"Value that uniquely identifies the report link associated with the task in the planning cycle stage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleTaskStageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle stage associated with the task.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleTaskType":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the type of task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskCompletionDate":{
            "type":"string",
            "description":"Date when the task in the planning cycle stage is completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Status name of the task in the planning cycle stage. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskStatusCode":{
            "maxLength":32,
            "type":"string",
            "description":"Status of the task in the planning cycle stage. A list of valid values for the task is defined in the lookup type ORA_MSC_SOP_TASK_STATUS.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanningCycleTaskDaysLate":{
            "type":"integer",
            "description":"Value that indicates the difference between the completion date and the due date for the task in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleTaskOwnerId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who owns the task in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanningCycleTaskAssignee":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who's assigned the task in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannningCycleTaskLink":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the report link associated with the task in the planning cycle stage.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the task in the planning cycle stage.",
            "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 : planningCycles-planningCycleStages-planningCycleParticipants-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who added the participant to the planning cycle stage.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user added the participant to the planning cycle stage.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the participant in the planning cycle stage.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the participant in the planning cycle stage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningCycleId: integer (int64)
  Value that uniquely identifies the planning cycle in which the user is a participant.
• PlanningCycleParticipantId: string
  Maximum Length: 64

  Value that uniquely identifies the user who's a participant in the planning cycle stage.
• PlanningCycleParticipantName: string
  Read Only: true

  Maximum Length: 255

  Name of the user who's a participant in the planning cycle stage.
• PlanningCycleParticipantsStageId: integer (int64)
  Value that uniquely identifies the planning cycle stage in which the user is a participant.
• PlanningCycleParticipantsStageName: string
  Read Only: true

  Maximum Length: 256

  Name of the planning cycle stage in which the user is a participant.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the participant in the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user added the participant to the planning cycle stage.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who added the participant to the planning cycle stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle in which the user is a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleParticipantsStageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle stage in which the user is a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleParticipantId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies the user who's a participant in the planning cycle stage.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanningCycleParticipantsStageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the planning cycle stage in which the user is a participant.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleParticipantName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who's a participant in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the participant in the planning cycle stage.",
            "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 : planningCycles-planningCycleWorkLists-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the task in the planning cycle worklist.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the task in the planning cycle worklist.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the task in the planning cycle worklist.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the task in the planning cycle worklist.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanningCycleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the planning cycle in which the worklist task was added.
• PlanningCycleWorkListActivityId: integer (int64)
  Read Only: true

  Value that uniquely identifies the planning cycle activity.
• PlanningCycleWorkListActivityTitle: string
  Read Only: true

  Maximum Length: 256

  Name of the activity in the planning cycle stage.
• PlanningCycleWorkListAssigneeId: string
  Read Only: true

  Maximum Length: 64

  Value that uniquely identifies who's assigned the task in the planning cycle worklist.
• PlanningCycleWorkListAssigneeName: string
  Read Only: true

  Maximum Length: 255

  Name of the user who's assigned the task in the planning cycle worklist.
• PlanningCycleWorkListComments: string
  Read Only: true

  Maximum Length: 1000

  Description of the planning cycle.
• PlanningCycleWorkListCompletionDate: string (date)
  Read Only: true

  Date when the task in the planning cycle worklist is completed.
• PlanningCycleWorkListDaysLate: integer
  Read Only: true

  Value that indicates the difference between the completion date and the due date for the task in the planning cycle worklist.
• PlanningCycleWorkListDueDate: string (date)
  Read Only: true

  Date when the task in the planning cycle worklist is due.
• PlanningCycleWorkListLink: string
  Read Only: true

  Maximum Length: 256

  Name of the report link associated with the task in the planning cycle worklist.
• PlanningCycleWorkListLinkId: integer (int64)
  Read Only: true

  Value that uniquely identifies the report link associated with the task in the worklist.
• PlanningCycleWorkListLinkType: integer (int32)
  Read Only: true

  Type of report link associated with the task in the planning cycle worklist. A valid value includes 2 for page group.
• PlanningCycleWorkListOffSetDays: integer
  Read Only: true

  Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.
• PlanningCycleWorkListOwner: string
  Read Only: true

  Maximum Length: 64

  Value that uniquely identifies who owns the task in the planning cycle worklist.
• PlanningCycleWorkListOwnerName: string
  Read Only: true

  Maximum Length: 255

  Name of the user who owns the task in the planning cycle worklist.
• PlanningCycleWorkListStageId: integer (int64)
  Read Only: true

  Value that uniquely identifies the planning cycle stage in which the worklist task was added.
• PlanningCycleWorkListStageName: string
  Read Only: true

  Maximum Length: 256

  Name of the planning cycle stage in which the worklist task was added.
• PlanningCycleWorkListStatus: string
  Read Only: true

  Maximum Length: 4000

  Status name of the task, action and decision item in the planning cycle worklist. A list of valid names for the task and action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid status names for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS.
• PlanningCycleWorkListStatusCode: string
  Read Only: true

  Maximum Length: 128

  Status of the task, action and decision item in the planning cycle worklist. A list of valid values for the task and action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid values for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS.
• PlanningCycleWorkListTaskId: integer
  Read Only: true

  Value that uniquely identifies the task in the planning cycle worklist.
• PlanningCycleWorkListTaskType: string
  Read Only: true

  Maximum Length: 256

  Name of the type of task in the planning cycle worklist. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.
• PlanningCycleWorkListTitle: string
  Read Only: true

  Maximum Length: 256

  Name of the task in the planning cycle worklist.

{
    "type":"object",
    "properties":{
        "PlanningCycleWorkListAssigneeName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who's assigned the task in the planning cycle worklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListLinkType":{
            "type":"integer",
            "description":"Type of report link associated with the task in the planning cycle worklist. A valid value includes 2 for page group.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the task in the planning cycle worklist.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListTitle":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the task in the planning cycle worklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListAssigneeId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who's assigned the task in the planning cycle worklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle in which the worklist task was added.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleWorkListTaskId":{
            "type":"integer",
            "description":"Value that uniquely identifies the task in the planning cycle worklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListOffSetDays":{
            "type":"integer",
            "description":"Value that specifies the task due date relative to the start of the planning cycle. For example, a value of 10 indicates the task is due 10 days after the start of the planning cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListDueDate":{
            "type":"string",
            "description":"Date when the task in the planning cycle worklist is due.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListDaysLate":{
            "type":"integer",
            "description":"Value that indicates the difference between the completion date and the due date for the task in the planning cycle worklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListLinkId":{
            "type":"integer",
            "description":"Value that uniquely identifies the report link associated with the task in the worklist.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleWorkListLink":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the report link associated with the task in the planning cycle worklist.",
            "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"
            }
        },
        "PlanningCycleWorkListOwner":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies who owns the task in the planning cycle worklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListComments":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the planning cycle.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListStageName":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the planning cycle stage in which the worklist task was added.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListOwnerName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the user who owns the task in the planning cycle worklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the task in the planning cycle worklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListActivityTitle":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the activity in the planning cycle stage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the task in the planning cycle worklist.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListStageId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle stage in which the worklist task was added.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleWorkListStatus":{
            "maxLength":4000,
            "type":"string",
            "description":"Status name of the task, action and decision item in the planning cycle worklist. A list of valid names for the task and action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid status names for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListStatusCode":{
            "maxLength":128,
            "type":"string",
            "description":"Status of the task, action and decision item in the planning cycle worklist. A list of valid values for the task and action item is defined in the lookup type ORA_MSC_SOP_TASK_STATUS. A list of valid values for the decision item is defined in the lookup type ORA_MSC_SOP_RECOMMEND_STATUS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListCompletionDate":{
            "type":"string",
            "description":"Date when the task in the planning cycle worklist is completed.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningCycleWorkListActivityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the planning cycle activity.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningCycleWorkListTaskType":{
            "maxLength":256,
            "type":"string",
            "description":"Name of the type of task in the planning cycle worklist. A list of valid names for the task is defined in the lookup type ORA_MSC_SOP_ACTIVITY_TASK_TYPE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the task in the planning cycle worklist.",
            "format":"date-time",
            "nullable":true,
            "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

planningCyclePlans

Operation: /fscmRestApi/resources/11.13.18.05/planningCycles/{PlanningCycleId}/child/planningCyclePlans

Parameters:

• PlanningCycleId: $request.path.PlanningCycleId

A planning cycle has one or more linked supply chain plans to analyze. For example, you can include the current baseline plan and alternative plans in the planning cycle. The links that you set up for an activity or task opens reports in the plans.

planningCycleStages

Operation: /fscmRestApi/resources/11.13.18.05/planningCycles/{PlanningCycleId}/child/planningCycleStages

Parameters:

• PlanningCycleId: $request.path.PlanningCycleId

A review stage represents the activities, tasks, and participants in a recurring planning process. For example, Demand Review and Supply Review are stages in a sales and operations planning process

planningCycleWorkLists

Operation: /fscmRestApi/resources/11.13.18.05/planningCycles/{PlanningCycleId}/child/planningCycleWorkLists

Parameters:

• PlanningCycleId: $request.path.PlanningCycleId

A worklist is a list of planning tasks that require user action.

Back to Top