Jump to

• Request
• Response

Add one sourcing program team member

post

/fscmRestApi/resources/11.13.18.05/sourcingPrograms/{ProgramHeaderId}/child/sourcingProgramMembers

Request

Path Parameters

• ProgramHeaderId(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: 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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccessTypeCode: string
  Maximum Length: 30

  Value that identifies the agent access for the lookup code. Valid value is MANAGE_NEGOTIATIONS.
• MemberType: string
  Maximum Length: 1

  Value that identifies the program team member type.
• Note: string
  Maximum Length: 4000

  Note entered for the program team member.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PersonId: integer (int64)
  Value that uniquely identifies the program team member name.
• ProgramHeaderId: integer (int64)
  Unique identifier for the program header in the program.
• TeamMemberId: integer (int64)
  Value that uniquely identifies the program team member name.

{
    "type":"object",
    "properties":{
        "AccessTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the agent access for the lookup code. Valid value is MANAGE_NEGOTIATIONS.",
            "nullable":true
        },
        "MemberType":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies the program team member type.",
            "nullable":true
        },
        "Note":{
            "maxLength":4000,
            "type":"string",
            "description":"Note entered for the program team member.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "PersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program team member name.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProgramHeaderId":{
            "type":"integer",
            "description":"Unique identifier for the program header in the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TeamMemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program team member name.",
            "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 : sourcingPrograms-sourcingProgramMembers-item-response

Type: object

Show Source

• AccessType: string
  Read Only: true

  Maximum Length: 255

  Determines the access level of the team member.
• AccessTypeCode: string
  Maximum Length: 30

  Value that identifies the agent access for the lookup code. Valid value is MANAGE_NEGOTIATIONS.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the program team member.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberType: string
  Maximum Length: 1

  Value that identifies the program team member type.
• Note: string
  Maximum Length: 4000

  Note entered for the program team member.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PersonId: integer (int64)
  Value that uniquely identifies the program team member name.
• PersonNameId: integer (int64)
  Read Only: true

  Value that uniquely identifies the name of the program team member.
• ProgramHeaderId: integer (int64)
  Unique identifier for the program header in the program.
• TeamMemberId: integer (int64)
  Value that uniquely identifies the program team member name.

{
    "type":"object",
    "properties":{
        "AccessType":{
            "maxLength":255,
            "type":"string",
            "description":"Determines the access level of the team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the agent access for the lookup code. Valid value is MANAGE_NEGOTIATIONS.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the program team member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberType":{
            "maxLength":1,
            "type":"string",
            "description":"Value that identifies the program team member type.",
            "nullable":true,
            "x-queryable":true
        },
        "Note":{
            "maxLength":4000,
            "type":"string",
            "description":"Note entered for the program team member.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program team member name.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonNameId":{
            "type":"integer",
            "description":"Value that uniquely identifies the name of the program team member.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramHeaderId":{
            "type":"integer",
            "description":"Unique identifier for the program header in the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TeamMemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program team member name.",
            "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"
            }
        }
    }
}

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