Jump to

• Request
• Response

Create one portfolio entry

post

/fscmRestApi/resources/11.13.18.05/productProposals/{ProductProposalId}/child/ProposalPortfolioRelationships

Request

Path Parameters

• ProductProposalId(required): integer(int64)
  Value that uniquely identifies the product proposal.

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

• PortfolioCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that identifies the portfolio
• PortfolioId: integer (int64)
  Value that uniquely identifies a portfolio
• PortfolioName: string
  Maximum Length: 255

  Name of the portfolio

{
    "type":"object",
    "properties":{
        "PortfolioId":{
            "type":"integer",
            "description":"Value that uniquely identifies a portfolio",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PortfolioCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the portfolio",
            "nullable":false
        },
        "PortfolioName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the portfolio",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : productProposals-ProposalPortfolioRelationships-item-response

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  Read Only: true

  End date for the portfolio
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PortfolioCode: string
  Title: Code

  Maximum Length: 30

  Abbreviation that identifies the portfolio
• PortfolioDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the portfolio
• PortfolioEnabled: string
  Title: Enabled Flag

  Read Only: true

  Maximum Length: 1

  Value that indicates the portfolio is enabled or disabled
• PortfolioId: integer (int64)
  Value that uniquely identifies a portfolio
• PortfolioName: string
  Maximum Length: 255

  Name of the portfolio
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  Start date of the portfolio

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the portfolio",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PortfolioId":{
            "type":"integer",
            "description":"Value that uniquely identifies a portfolio",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PortfolioDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the portfolio",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date for the portfolio",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PortfolioEnabled":{
            "title":"Enabled Flag",
            "maxLength":"1",
            "type":"string",
            "description":"Value that indicates the portfolio is enabled or disabled",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PortfolioCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the portfolio",
            "nullable":false,
            "x-queryable":true
        },
        "PortfolioName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the portfolio",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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