Jump to

• Request
• Response
• Examples

Create one release backlog plan results job

post

/fscmRestApi/resources/11.13.18.05/bmDemandsReleaseJobs

Request

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

• CreatedBy: string
  Maximum Length: 64

  Name of the user who initially created the release backlog planning results job.
• DemandsReleaseExecutions: array Demands Release Executions
  Title: Demands Release Executions

  The progress and status of each run of a release backlog planning results job.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the backlog management release job.
• ProcessId: integer
  Unique identifier of the scheduled process named Release Backlog Planning Results.
• ReleaseCriteria: string
  Filter criteria applied for the release backlog planning results job.
• ReleaseDemandIdList: string
  List of unique Identifier of demands that will be released.
• ReleaseId: integer
  Unique Identifier of a demand that will be released.
• Status: number
  Status of the release backlog planning results job.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"number",
            "description":"Status of the release backlog planning results job.",
            "nullable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the backlog management release job.",
            "nullable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who initially created the release backlog planning results job.",
            "nullable":true
        },
        "ReleaseDemandIdList":{
            "type":"string",
            "description":"List of unique Identifier of demands that will be released.",
            "nullable":true
        },
        "ReleaseCriteria":{
            "type":"string",
            "description":"Filter criteria applied for the release backlog planning results job.",
            "nullable":true
        },
        "DemandsReleaseExecutions":{
            "title":"Demands Release Executions",
            "type":"array",
            "description":"The progress and status of each run of a release backlog planning results job.",
            "items":{
                "$ref":"#/components/schemas/bmDemandsReleaseJobs-DemandsReleaseExecutions-item-post-request"
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier of the scheduled process named Release Backlog Planning Results.",
            "nullable":true
        },
        "ReleaseId":{
            "type":"integer",
            "description":"Unique Identifier of a demand that will be released.",
            "nullable":true
        }
    }
}

Nested Schema : Demands Release Executions

Type: array

Title: Demands Release Executions

The progress and status of each run of a release backlog planning results job.

Show Source

• Array of: object bmDemandsReleaseJobs-DemandsReleaseExecutions-item-post-request

{
    "title":"Demands Release Executions",
    "type":"array",
    "description":"The progress and status of each run of a release backlog planning results job.",
    "items":{
        "$ref":"#/components/schemas/bmDemandsReleaseJobs-DemandsReleaseExecutions-item-post-request"
    }
}

Nested Schema : bmDemandsReleaseJobs-DemandsReleaseExecutions-item-post-request

Type: object

Show Source

• ProcessId: integer
  Unique identifier of the scheduled process named Release Backlog Planning Results.
• ReleaseId: integer (int64)
  Percent completion of the release backlog planning results job.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier of the scheduled process named Release Backlog Planning Results.",
            "nullable":true
        },
        "ReleaseId":{
            "type":"integer",
            "description":"Percent completion of the release backlog planning results job.",
            "format":"int64",
            "nullable":true,
            "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 : bmDemandsReleaseJobs-item-response

Type: object

Show Source

• CreatedBy: string
  Maximum Length: 64

  Name of the user who initially created the release backlog planning results job.
• DemandsReleaseExecutions: array Demands Release Executions
  Title: Demands Release Executions

  The progress and status of each run of a release backlog planning results job.
• LastUpdatedBy: string
  Maximum Length: 64

  User who most recently updated the backlog management release job.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProcessId: integer
  Unique identifier of the scheduled process named Release Backlog Planning Results.
• ReleaseCriteria: string
  Filter criteria applied for the release backlog planning results job.
• ReleaseDemandIdList: string
  List of unique Identifier of demands that will be released.
• ReleaseId: integer
  Unique Identifier of a demand that will be released.
• Status: number
  Status of the release backlog planning results job.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"number",
            "description":"Status of the release backlog planning results job.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the backlog management release job.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who initially created the release backlog planning results job.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseDemandIdList":{
            "type":"string",
            "description":"List of unique Identifier of demands that will be released.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseCriteria":{
            "type":"string",
            "description":"Filter criteria applied for the release backlog planning results job.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DemandsReleaseExecutions":{
            "title":"Demands Release Executions",
            "type":"array",
            "description":"The progress and status of each run of a release backlog planning results job.",
            "items":{
                "$ref":"#/components/schemas/bmDemandsReleaseJobs-DemandsReleaseExecutions-item-response"
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier of the scheduled process named Release Backlog Planning Results.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseId":{
            "type":"integer",
            "description":"Unique Identifier of a demand that will be released.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Demands Release Executions

Type: array

Title: Demands Release Executions

The progress and status of each run of a release backlog planning results job.

Show Source

• Array of: object bmDemandsReleaseJobs-DemandsReleaseExecutions-item-response

{
    "title":"Demands Release Executions",
    "type":"array",
    "description":"The progress and status of each run of a release backlog planning results job.",
    "items":{
        "$ref":"#/components/schemas/bmDemandsReleaseJobs-DemandsReleaseExecutions-item-response"
    }
}

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 : bmDemandsReleaseJobs-DemandsReleaseExecutions-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PercentageCompleted: number
  Read Only: true

  Percent completion of the release backlog planning results job.
• ProcessId: integer
  Unique identifier of the scheduled process named Release Backlog Planning Results.
• ReleaseId: integer (int64)
  Percent completion of the release backlog planning results job.
• Status: number
  Read Only: true

  Status of the release backlog planning results job. Valid values are 1 for success and 2 for failure. This attribute doesn't have a default value.
• StepSequence: string
  Read Only: true

  Maximum Length: 20

  Value that identifies the step of the release backlog planning results job.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"number",
            "description":"Status of the release backlog planning results job. Valid values are 1 for success and 2 for failure. This attribute doesn't have a default value.",
            "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"
            }
        },
        "StepSequence":{
            "maxLength":20,
            "type":"string",
            "description":"Value that identifies the step of the release backlog planning results job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessId":{
            "type":"integer",
            "description":"Unique identifier of the scheduled process named Release Backlog Planning Results.",
            "nullable":true,
            "x-queryable":true
        },
        "ReleaseId":{
            "type":"integer",
            "description":"Percent completion of the release backlog planning results job.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PercentageCompleted":{
            "type":"number",
            "description":"Percent completion of the release backlog planning results job.",
            "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"
    }
}

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."
        }
    }
}

Links

DemandsReleaseExecutions

Operation: /fscmRestApi/resources/11.13.18.05/bmDemandsReleaseJobs/{bmDemandsReleaseJobsUniqID}/child/DemandsReleaseExecutions

Parameters:

• bmDemandsReleaseJobsUniqID: $request.path.bmDemandsReleaseJobsUniqID

The progress and status of each run of a release backlog planning results job.

Back to Top

Examples

This example describes how to create one release backlog plan results job.

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/bmDemandsReleaseJobs"

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.

{     
  "ReleaseCriteria":"OrderNumber like '%BLM-PHANTOM-SO3'"
}

Note:

You can use other attributes in the request payload.

Example 1: Request payload with release demand ID list :

{
 "ReleaseDemandIdList" : "2934262,2934263"
}

Example 2: Request payload with order number in the release criteria:

{
"ReleaseCriteria": "OrderNumber='BLM_MR_SHIPSET1'"
}

Example Response Body

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

{
    "ProcessId": 278750,
    "ReleaseId": 44022,
    "Status": null,
    "LastUpdatedBy": null,
    "CreatedBy": null,
    "ReleaseCriteria": null,
    "ReleaseDemandIdList": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/bmDemandsReleaseJobs/00020000000EACED0005770800000000000440DE0000000EACED00057708000000000000ABF6",
            "name": "bmDemandsReleaseJobs",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/bmDemandsReleaseJobs/00020000000EACED0005770800000000000440DE0000000EACED00057708000000000000ABF6",
            "name": "bmDemandsReleaseJobs",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/bmDemandsReleaseJobs/00020000000EACED0005770800000000000440DE0000000EACED00057708000000000000ABF6/child/DemandsReleaseExecutions",
            "name": "DemandsReleaseExecutions",
            "kind": "collection"
        }
    ]
}

Back to Top