Jump to

• Request
• Response
• Examples

Create release processes

post

/fscmRestApi/resources/11.13.18.05/backlogManagementPlans/{BmRunId}/child/releases

Request

Path Parameters

• BmRunId(required): integer
  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

• BmRunId: integer (int64)
  Value that uniquely identifies the backlog management run from which releases are made to order management.
• Category: string
  Item category whose demands need to be released.
• CreatedBy: string
  Maximum Length: 64

  Name of the user who initiated the release process.
• CreationDate: string (date-time)
  Date when the user initiated the release process.
• Customer: string
  Customer whose demands need to be released.
• Item: string
  Item whose demands need to be released.
• LastUpdateDate: string (date-time)
  Date when the user most recently updated the backlog management release process data.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the backlog management release process data.
• LastUpdateLogin: string
  Maximum Length: 32

  Login of the user who most recently updated the backlog management release process data.
• Organization: string
  Organization from which demands need to be released.
• ProcessId: integer (int64)
  Value that uniquely identifies the process that releases demands from backlog management to order management.
• Status: number
  Status of the release process. Valid values are 0 for failure and 1 for success.
• StepSequence: number
  Sequence number within the technical release process.

{
    "type":"object",
    "properties":{
        "BmRunId":{
            "type":"integer",
            "description":"Value that uniquely identifies the backlog management run from which releases are made to order management.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Category":{
            "type":"string",
            "description":"Item category whose demands need to be released.",
            "nullable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who initiated the release process.",
            "nullable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user initiated the release process.",
            "format":"date-time",
            "nullable":false
        },
        "Customer":{
            "type":"string",
            "description":"Customer whose demands need to be released.",
            "nullable":true
        },
        "Item":{
            "type":"string",
            "description":"Item whose demands need to be released.",
            "nullable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the backlog management release process data.",
            "format":"date-time",
            "nullable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who most recently updated the backlog management release process data.",
            "nullable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the backlog management release process data.",
            "nullable":false
        },
        "Organization":{
            "type":"string",
            "description":"Organization from which demands need to be released.",
            "nullable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process that releases demands from backlog management to order management.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Status":{
            "type":"number",
            "description":"Status of the release process. Valid values are 0 for failure and 1 for success.",
            "nullable":true
        },
        "StepSequence":{
            "type":"number",
            "description":"Sequence number within the technical release process.",
            "nullable":false
        }
    }
}

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 : backlogManagementPlans-releases-item-response

Type: object

Show Source

• BmRunId: integer (int64)
  Value that uniquely identifies the backlog management run from which releases are made to order management.
• Category: string
  Item category whose demands need to be released.
• CreatedBy: string
  Maximum Length: 64

  Name of the user who initiated the release process.
• CreationDate: string (date-time)
  Date when the user initiated the release process.
• Customer: string
  Customer whose demands need to be released.
• Item: string
  Item whose demands need to be released.
• LastUpdateDate: string (date-time)
  Date when the user most recently updated the backlog management release process data.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the backlog management release process data.
• LastUpdateLogin: string
  Maximum Length: 32

  Login of the user who most recently updated the backlog management release process data.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Organization: string
  Organization from which demands need to be released.
• ProcessId: integer (int64)
  Value that uniquely identifies the process that releases demands from backlog management to order management.
• Status: number
  Status of the release process. Valid values are 0 for failure and 1 for success.
• StepSequence: number
  Sequence number within the technical release process.

{
    "type":"object",
    "properties":{
        "BmRunId":{
            "type":"integer",
            "description":"Value that uniquely identifies the backlog management run from which releases are made to order management.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Category":{
            "type":"string",
            "description":"Item category whose demands need to be released.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who initiated the release process.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user initiated the release process.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "Customer":{
            "type":"string",
            "description":"Customer whose demands need to be released.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "type":"string",
            "description":"Item whose demands need to be released.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the backlog management release process data.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who most recently updated the backlog management release process data.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the backlog management release process data.",
            "nullable":false,
            "x-queryable":true
        },
        "Organization":{
            "type":"string",
            "description":"Organization from which demands need to be released.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the process that releases demands from backlog management to order management.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "type":"number",
            "description":"Status of the release process. Valid values are 0 for failure and 1 for success.",
            "nullable":true,
            "x-queryable":true
        },
        "StepSequence":{
            "type":"number",
            "description":"Sequence number within the technical release process.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 release processes.

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/backlogManagementPlans/-1/child/releases"

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.

{
	"Organization":null,
	"Category": null,
	"Item":"BLM-MO-ITEM1",
	"Customer": null
}

Example Response Body

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

{
	"ProcessId": 171030,
	"BmRunId": -1,
	"Status": null,
	"CreatedBy": null,
	"CreationDate": null,
	"LastUpdateDate": null,
	"LastUpdatedBy": null,
	"LastUpdateLogin": null,
	"StepSequence": null,
	"Organization": null,
	"Category": null,
	"Item": "BLM-MO-ITEM1",
	"Customer": null
}

Back to Top