Jump to

• Request
• Response
• Examples

Create runs

post

/fscmRestApi/resources/11.13.18.05/planningSegmentGroups/{SegmentGroupId}/child/ExecutePartsSegmentation

Request

Path Parameters

• SegmentGroupId(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:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ExecutionId: integer (int64)
  Value that uniquely identifies the process.
• JobId: integer (int64)
  Value that uniquely identifies the scheduled process.
• RetainOverrides: string
  Value that indicates whether or not to retain existing policy overrides. Valid values are 0 or 1. If 0, then retain policy overrides. If 1, then don't retain policy overrides. The default value is 0.
• SaveLastResult: string
  Value that indicates whether or not to save the last segmentation result. Valid values are 1 or 2. If 1, then save the last result. If 2, then don't save the last result. The default value is 2.
• SegmentGroupId: integer (int64)
  Value that uniquely identifies the segment group.
• StatusCode: integer (int32)
  Value that identifies the status of the segmentation process that was run. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.

{
    "type":"object",
    "properties":{
        "SaveLastResult":{
            "type":"string",
            "description":"Value that indicates whether or not to save the last segmentation result. Valid values are 1 or 2. If 1, then save the last result. If 2, then don't save the last result. The default value is 2.",
            "nullable":true
        },
        "RetainOverrides":{
            "type":"string",
            "description":"Value that indicates whether or not to retain existing policy overrides. Valid values are 0 or 1. If 0, then retain policy overrides. If 1, then don't retain policy overrides. The default value is 0.",
            "nullable":true
        },
        "SegmentGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StatusCode":{
            "type":"integer",
            "description":"Value that identifies the status of the segmentation process that was run. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            }
        },
        "JobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : planningSegmentGroups-ExecutePartsSegmentation-item-response

Type: object

Show Source

• ExecutionId: integer (int64)
  Value that uniquely identifies the process.
• JobId: integer (int64)
  Value that uniquely identifies the scheduled process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RetainOverrides: string
  Value that indicates whether or not to retain existing policy overrides. Valid values are 0 or 1. If 0, then retain policy overrides. If 1, then don't retain policy overrides. The default value is 0.
• SaveLastResult: string
  Value that indicates whether or not to save the last segmentation result. Valid values are 1 or 2. If 1, then save the last result. If 2, then don't save the last result. The default value is 2.
• SegmentGroupId: integer (int64)
  Value that uniquely identifies the segment group.
• StatusCode: integer (int32)
  Value that identifies the status of the segmentation process that was run. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.

{
    "type":"object",
    "properties":{
        "SaveLastResult":{
            "type":"string",
            "description":"Value that indicates whether or not to save the last segmentation result. Valid values are 1 or 2. If 1, then save the last result. If 2, then don't save the last result. The default value is 2.",
            "nullable":true,
            "x-queryable":true
        },
        "RetainOverrides":{
            "type":"string",
            "description":"Value that indicates whether or not to retain existing policy overrides. Valid values are 0 or 1. If 0, then retain policy overrides. If 1, then don't retain policy overrides. The default value is 0.",
            "nullable":true,
            "x-queryable":true
        },
        "SegmentGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the segment group.",
            "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"
            }
        },
        "StatusCode":{
            "type":"integer",
            "description":"Value that identifies the status of the segmentation process that was run. A list of accepted values is defined in the lookup type ORA_MSC_PLAN_STATUS_TYPE.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "JobId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduled process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExecutionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to create runs.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/planningSegmentGroups/SegmentGroupId/child/ExecutePartsSegmentation"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{}

Example Response Body

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

{
	"SegmentGroupId": 300100187869584,
	"JobId": 79218,
	"StatusCode": 1,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/planningSegmentGroups/300100187869584/child/ExecutePartsSegmentation/300100187868365",
		"name": "ExecutePartsSegmentation",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/planningSegmentGroups/300100187869584/child/ExecutePartsSegmentation/300100187868365",
		"name": "ExecutePartsSegmentation",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/planningSegmentGroups/300100187869584",
		"name": "planningSegmentGroups",
		"kind": "item"
	}
	]
}

Back to Top