Jump to

• Request
• Response
• Examples

Create one team member

post

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

Request

Path Parameters

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

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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

• TeamId: integer (int64)
  Value that uniquely identifies the team member.
• UserId: integer (int64)
  Value that uniquely identifies the user who is part of the team.
• UserName: string
  Name of the user who is part of the team.

{
    "type":"object",
    "properties":{
        "UserName":{
            "type":"string",
            "description":"Name of the user who is part of the team.",
            "nullable":true
        },
        "TeamId":{
            "type":"integer",
            "description":"Value that uniquely identifies the team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UserId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user who is part of the team.",
            "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(required):
  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(required):
  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-Team-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the proposal team member.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the proposal team member.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the user who is part of the team.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the proposal team.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the proposal team.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TeamId: integer (int64)
  Value that uniquely identifies the team member.
• UserId: integer (int64)
  Value that uniquely identifies the user who is part of the team.
• UserName: string
  Name of the user who is part of the team.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the proposal team.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the proposal team member.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the proposal team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserName":{
            "type":"string",
            "description":"Name of the user who is part of the team.",
            "nullable":true,
            "x-queryable":true
        },
        "UserId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user who is part of the team.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the user who is part of the team.",
            "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"
            }
        },
        "TeamId":{
            "type":"integer",
            "description":"Value that uniquely identifies the team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the proposal team.",
            "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 : 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 a team member.

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/productProposals/ProductProposalId/child/Team"

Example Request Body

The following example includes the contents of the request body in JSON format to add a team member entry by User ID for a proposal. 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.

{
	"UserId": 100100013798698
}

Example Response Body

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

{
	"TeamId": 300100252034842,
	"UserId": 100100013798698,
	"UserName": "TEST_USER",
	"DisplayName": "Test User",
	"CreatedBy": "PRODUCT_MANAGER",
	"CreationDate": "2020-09-04T11:45:22+00:00",
	"LastUpdatedBy": "PRODUCT_MANAGER",
	"LastUpdateDate": "2020-09-04T11:45:25.034+00:00",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/productProposals/300100252024523/child/Team/300100252034842",
		"name": "Team",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/productProposals/300100252024523/child/Team/300100252034842",
		"name": "Team",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/productProposals/300100252024523",
		"name": "productProposals",
		"kind": "item"
	}
	]
}

Example Request Body

The following example includes the contents of the request body in JSON format to add a team member entry by User Name for a proposal. 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.

{
	"UserName": "TEST_USER"
}

Example Response Body

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

{
	"TeamId": 300100252034842,
	"UserId": 100100013798698,
	"UserName": "TEST_USER",
	"DisplayName": "Test User",
	"CreatedBy": "PRODUCT_MANAGER",
	"CreationDate": "2020-09-04T11:45:22+00:00",
	"LastUpdatedBy": "PRODUCT_MANAGER",
	"LastUpdateDate": "2020-09-04T11:45:25.034+00:00",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/productProposals/300100252024523/child/Team/300100252034842",
		"name": "Team",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/productProposals/300100252024523/child/Team/300100252034842",
		"name": "Team",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/productProposals/300100252024523",
		"name": "productProposals",
		"kind": "item"
	}
	]
}

Back to Top