Jump to

• Request
• Response

Create contract parties

post

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty

Request

Path Parameters

• contractsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.

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

• ContractClass: string
  Maximum Length: 80

  The contract class.
• ContractPartyContact: array Contract Party Contacts
  Title: Contract Party Contacts

  The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.
• ContractPartyFlexfieldVA: array Contract Party Flexfields
  Title: Contract Party Flexfields

  The contract party flex fields is used to view, create, update contract party flex field information.
• DeleteFlag: boolean
  Default Value: false

  Delete Flag
• ExternalKey: string
  Maximum Length: 120

  The key identifier of the contract party in the external source system.
• ExternalSource: string
  Maximum Length: 120

  The name of external source system where the contract party is imported from.
• Id: integer (int64)
  The unique identifier of the contract party.
• MajorVersion: integer (int64)
  Default Value: 1

  The version of the contract party.
• PartyId(required): integer (int64)
  The unique identifier of the contract party.
• PartyName: string
  Title: Name

  The name of the contract party.
• PartyNameLOVSwitcher: string
  The party name LOV switcher.
• PartyRoleCode(required): string
  Title: Role

  Maximum Length: 30

  The code that indicates the party role.
• PartyRolePuid: string
  Title: Party Role PUID

  Maximum Length: 120

  Party Role PUID
• Role: string
  The name of the party role.
• SignedBy: string
  Title: Signed By

  Maximum Length: 100

  The party that signed the contract.
• SignedDate: string (date)
  Title: Signed Date

  The date on which the party signed the contract.
• SignerRole: string
  Title: Signer Role

  Maximum Length: 100

  Signer Role

{
    "required":[
        "PartyId",
        "PartyRoleCode"
    ],
    "type":"object",
    "properties":{
        "ContractClass":{
            "maxLength":80,
            "type":"string",
            "description":"The contract class.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractPartyContact":{
            "title":"Contract Party Contacts",
            "type":"array",
            "description":"The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyContact-item-post-request"
            }
        },
        "ContractPartyFlexfieldVA":{
            "title":"Contract Party Flexfields",
            "type":"array",
            "description":"The contract party flex fields is used to view, create, update contract party flex field information.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyFlexfieldVA-item-post-request"
            },
            "x-cardinality":"1"
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Delete Flag",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"The key identifier of the contract party in the external source system.",
            "nullable":true
        },
        "ExternalSource":{
            "maxLength":120,
            "type":"string",
            "description":"The name of external source system where the contract party is imported from.",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the contract party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MajorVersion":{
            "type":"integer",
            "description":"The version of the contract party.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the contract party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the contract party.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PartyNameLOVSwitcher":{
            "type":"string",
            "description":"The party name LOV switcher.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyRoleCode":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the party role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartyRolePuid":{
            "title":"Party Role PUID",
            "maxLength":120,
            "type":"string",
            "description":"Party Role PUID",
            "nullable":true
        },
        "Role":{
            "type":"string",
            "description":"The name of the party role.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SignedBy":{
            "title":"Signed By",
            "maxLength":100,
            "type":"string",
            "description":"The party that signed the contract.",
            "nullable":true
        },
        "SignedDate":{
            "title":"Signed Date",
            "type":"string",
            "description":"The date on which the party signed the contract.",
            "format":"date",
            "nullable":true
        },
        "SignerRole":{
            "title":"Signer Role",
            "maxLength":100,
            "type":"string",
            "description":"Signer Role",
            "nullable":true
        }
    }
}

Nested Schema : Contract Party Contacts

Type: array

Title: Contract Party Contacts

The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.

Show Source

• Array of: object contracts-ContractParty-ContractPartyContact-item-post-request

{
    "title":"Contract Party Contacts",
    "type":"array",
    "description":"The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyContact-item-post-request"
    }
}

Nested Schema : Contract Party Flexfields

Type: array

Title: Contract Party Flexfields

The contract party flex fields is used to view, create, update contract party flex field information.

Show Source

• Array of: object contracts-ContractParty-ContractPartyFlexfieldVA-item-post-request

{
    "title":"Contract Party Flexfields",
    "type":"array",
    "description":"The contract party flex fields is used to view, create, update contract party flex field information.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyFlexfieldVA-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : contracts-ContractParty-ContractPartyContact-item-post-request

Type: object

Show Source

• AccessLevel: string
  Title: Access

  Maximum Length: 30

  The access level of a contract party contact.
• AccessLevelName: string
  The name of the access level of the contract party contact.
• ContactId(required): integer (int64)
  The unique identifier of the contact.
• ContactPuid: string
  Title: Party Contact PUID

  Maximum Length: 120

  Contact PUID
• ContactRoleCode(required): string
  Title: Role

  Maximum Length: 30

  The code indicating the role of the contract party contact.
• ContractPartyContactFlexfieldVA: array Contract Party Contact Flexfields
  Title: Contract Party Contact Flexfields

  The contract party contact flex field resource is used to view, create, update contract party contact flex field information.
• EndDate: string (date)
  Title: End Date

  End Date
• ExternalKey: string
  Maximum Length: 120

  The key identifier of the contract party contact in the external source system.
• ExternalSource: string
  Maximum Length: 120

  The name of external source system where the contract party contact is imported from.
• Id: integer (int64)
  The unique identifier of the contract party contact.
• MajorVersion: integer (int64)
  Default Value: 1

  The version of the contract party contact.
• OwnerFlag: boolean
  Title: Owner

  indicates whether the contact is the owner of the contract.
• PartyContactName: string
  The name of the contract party contact.
• Role: string
  The role of the contract party contact.
• RoutingSequence: number
  Title: Signing Sequence

  Signing Sequence
• SignatureRole: string
  Title: Signature Role

  Maximum Length: 30

  Signatory Role Code
• SignatureRoleMeaning: string
  Signatory Role
• SignerSequence: integer
  Title: Display Sequence

  Singer Sequence
• StartDate: string (date)
  Title: Start Date

  Start Date

{
    "required":[
        "ContactId",
        "ContactRoleCode"
    ],
    "type":"object",
    "properties":{
        "AccessLevel":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The access level of a contract party contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessLevelName":{
            "type":"string",
            "description":"The name of the access level of the contract party contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContactPuid":{
            "title":"Party Contact PUID",
            "maxLength":120,
            "type":"string",
            "description":"Contact PUID",
            "nullable":true
        },
        "ContactRoleCode":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the role of the contract party contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContractPartyContactFlexfieldVA":{
            "title":"Contract Party Contact Flexfields",
            "type":"array",
            "description":"The contract party contact flex field resource is used to view, create, update contract party contact flex field information.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-post-request"
            },
            "x-cardinality":"1"
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date",
            "nullable":true
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"The key identifier of the contract party contact in the external source system.",
            "nullable":true
        },
        "ExternalSource":{
            "maxLength":120,
            "type":"string",
            "description":"The name of external source system where the contract party contact is imported from.",
            "nullable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the contract party contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MajorVersion":{
            "type":"integer",
            "description":"The version of the contract party contact.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            }
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"indicates whether the contact is the owner of the contract.",
            "nullable":true
        },
        "PartyContactName":{
            "type":"string",
            "description":"The name of the contract party contact.",
            "nullable":true
        },
        "Role":{
            "type":"string",
            "description":"The role of the contract party contact.",
            "nullable":true
        },
        "RoutingSequence":{
            "title":"Signing Sequence",
            "type":"number",
            "description":"Signing Sequence",
            "nullable":true
        },
        "SignatureRole":{
            "title":"Signature Role",
            "maxLength":30,
            "type":"string",
            "description":"Signatory Role Code",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SignatureRoleMeaning":{
            "type":"string",
            "description":"Signatory Role",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SignerSequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Singer Sequence",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start Date",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : Contract Party Contact Flexfields

Type: array

Title: Contract Party Contact Flexfields

The contract party contact flex field resource is used to view, create, update contract party contact flex field information.

Show Source

• Array of: object contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-post-request

{
    "title":"Contract Party Contact Flexfields",
    "type":"array",
    "description":"The contract party contact flex field resource is used to view, create, update contract party contact flex field information.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 90

  Descriptive Flexfield: structure definition of the user descriptive flexfield.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• Id: integer (int64)
  Contract Party Contact Flexfield ID
• MajorVersion: integer (int64)
  Default Value: 1

  Major Version

{
    "type":"object",
    "properties":{
        "Id":{
            "type":"integer",
            "description":"Contract Party Contact Flexfield ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "MajorVersion":{
            "type":"integer",
            "description":"Major Version",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":90,
            "type":"string",
            "description":"Descriptive Flexfield: structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : contracts-ContractParty-ContractPartyFlexfieldVA-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 90

  Descriptive Flexfield: structure definition of the user descriptive flexfield.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• Id: integer (int64)
  Contract Party Flexfield ID
• MajorVersion: integer (int64)
  Default Value: 1

  Major Version

{
    "type":"object",
    "properties":{
        "Id":{
            "type":"integer",
            "description":"Contract Party Flexfield ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "MajorVersion":{
            "type":"integer",
            "description":"Major Version",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":90,
            "type":"string",
            "description":"Descriptive Flexfield: structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : contracts-ContractParty-item-response

Type: object

Show Source

• ContractClass: string
  Maximum Length: 80

  The contract class.
• ContractPartyContact: array Contract Party Contacts
  Title: Contract Party Contacts

  The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.
• ContractPartyFlexfieldVA: array Contract Party Flexfields
  Title: Contract Party Flexfields

  The contract party flex fields is used to view, create, update contract party flex field information.
• DeleteFlag: boolean
  Default Value: false

  Delete Flag
• ExternalKey: string
  Maximum Length: 120

  The key identifier of the contract party in the external source system.
• ExternalSource: string
  Maximum Length: 120

  The name of external source system where the contract party is imported from.
• HeaderStartDate: string
  Read Only: true

  The header start date.
• Id: integer (int64)
  The unique identifier of the contract party.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Default Value: 1

  The version of the contract party.
• PartyId: integer (int64)
  The unique identifier of the contract party.
• PartyName: string
  Title: Name

  The name of the contract party.
• PartyNameLOVSwitcher: string
  The party name LOV switcher.
• PartyRoleCode: string
  Title: Role

  Maximum Length: 30

  The code that indicates the party role.
• PartyRolePuid: string
  Title: Party Role PUID

  Maximum Length: 120

  Party Role PUID
• Role: string
  The name of the party role.
• SignedBy: string
  Title: Signed By

  Maximum Length: 100

  The party that signed the contract.
• SignedDate: string (date)
  Title: Signed Date

  The date on which the party signed the contract.
• SignerRole: string
  Title: Signer Role

  Maximum Length: 100

  Signer Role

{
    "type":"object",
    "properties":{
        "ContractClass":{
            "maxLength":80,
            "type":"string",
            "description":"The contract class.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractPartyContact":{
            "title":"Contract Party Contacts",
            "type":"array",
            "description":"The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyContact-item-response"
            }
        },
        "ContractPartyFlexfieldVA":{
            "title":"Contract Party Flexfields",
            "type":"array",
            "description":"The contract party flex fields is used to view, create, update contract party flex field information.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyFlexfieldVA-item-response"
            },
            "x-cardinality":"1"
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Delete Flag",
            "nullable":true,
            "default":false,
            "x-queryable":false
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"The key identifier of the contract party in the external source system.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSource":{
            "maxLength":120,
            "type":"string",
            "description":"The name of external source system where the contract party is imported from.",
            "nullable":true,
            "x-queryable":true
        },
        "HeaderStartDate":{
            "type":"string",
            "description":"The header start date.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the contract party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MajorVersion":{
            "type":"integer",
            "description":"The version of the contract party.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the contract party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the contract party.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PartyNameLOVSwitcher":{
            "type":"string",
            "description":"The party name LOV switcher.",
            "nullable":true,
            "x-queryable":false
        },
        "PartyRoleCode":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates the party role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyRolePuid":{
            "title":"Party Role PUID",
            "maxLength":120,
            "type":"string",
            "description":"Party Role PUID",
            "nullable":true,
            "x-queryable":true
        },
        "Role":{
            "type":"string",
            "description":"The name of the party role.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SignedBy":{
            "title":"Signed By",
            "maxLength":100,
            "type":"string",
            "description":"The party that signed the contract.",
            "nullable":true,
            "x-queryable":true
        },
        "SignedDate":{
            "title":"Signed Date",
            "type":"string",
            "description":"The date on which the party signed the contract.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SignerRole":{
            "title":"Signer Role",
            "maxLength":100,
            "type":"string",
            "description":"Signer Role",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Contract Party Contacts

Type: array

Title: Contract Party Contacts

The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.

Show Source

• Array of: object contracts-ContractParty-ContractPartyContact-item-response

{
    "title":"Contract Party Contacts",
    "type":"array",
    "description":"The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyContact-item-response"
    }
}

Nested Schema : Contract Party Flexfields

Type: array

Title: Contract Party Flexfields

The contract party flex fields is used to view, create, update contract party flex field information.

Show Source

• Array of: object contracts-ContractParty-ContractPartyFlexfieldVA-item-response

{
    "title":"Contract Party Flexfields",
    "type":"array",
    "description":"The contract party flex fields is used to view, create, update contract party flex field information.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyFlexfieldVA-item-response"
    },
    "x-cardinality":"1"
}

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 : contracts-ContractParty-ContractPartyContact-item-response

Type: object

Show Source

• AccessLevel: string
  Title: Access

  Maximum Length: 30

  The access level of a contract party contact.
• AccessLevelName: string
  The name of the access level of the contract party contact.
• ContactId: integer (int64)
  The unique identifier of the contact.
• ContactPuid: string
  Title: Party Contact PUID

  Maximum Length: 120

  Contact PUID
• ContactRoleCode: string
  Title: Role

  Maximum Length: 30

  The code indicating the role of the contract party contact.
• ContractPartyContactFlexfieldVA: array Contract Party Contact Flexfields
  Title: Contract Party Contact Flexfields

  The contract party contact flex field resource is used to view, create, update contract party contact flex field information.
• EndDate: string (date)
  Title: End Date

  End Date
• ExternalKey: string
  Maximum Length: 120

  The key identifier of the contract party contact in the external source system.
• ExternalSource: string
  Maximum Length: 120

  The name of external source system where the contract party contact is imported from.
• Id: integer (int64)
  The unique identifier of the contract party contact.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Default Value: 1

  The version of the contract party contact.
• OwnerFlag: boolean
  Title: Owner

  indicates whether the contact is the owner of the contract.
• PartyContactName: string
  The name of the contract party contact.
• Role: string
  The role of the contract party contact.
• RoutingSequence: number
  Title: Signing Sequence

  Signing Sequence
• SignatureRole: string
  Title: Signature Role

  Maximum Length: 30

  Signatory Role Code
• SignatureRoleMeaning: string
  Signatory Role
• SignerSequence: integer
  Title: Display Sequence

  Singer Sequence
• StartDate: string (date)
  Title: Start Date

  Start Date

{
    "type":"object",
    "properties":{
        "AccessLevel":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The access level of a contract party contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccessLevelName":{
            "type":"string",
            "description":"The name of the access level of the contract party contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactId":{
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactPuid":{
            "title":"Party Contact PUID",
            "maxLength":120,
            "type":"string",
            "description":"Contact PUID",
            "nullable":true,
            "x-queryable":true
        },
        "ContactRoleCode":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the role of the contract party contact.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContractPartyContactFlexfieldVA":{
            "title":"Contract Party Contact Flexfields",
            "type":"array",
            "description":"The contract party contact flex field resource is used to view, create, update contract party contact flex field information.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-response"
            },
            "x-cardinality":"1"
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End Date",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalKey":{
            "maxLength":120,
            "type":"string",
            "description":"The key identifier of the contract party contact in the external source system.",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSource":{
            "maxLength":120,
            "type":"string",
            "description":"The name of external source system where the contract party contact is imported from.",
            "nullable":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the contract party contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MajorVersion":{
            "type":"integer",
            "description":"The version of the contract party contact.",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"indicates whether the contact is the owner of the contract.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyContactName":{
            "type":"string",
            "description":"The name of the contract party contact.",
            "nullable":true,
            "x-queryable":true
        },
        "Role":{
            "type":"string",
            "description":"The role of the contract party contact.",
            "nullable":true,
            "x-queryable":true
        },
        "RoutingSequence":{
            "title":"Signing Sequence",
            "type":"number",
            "description":"Signing Sequence",
            "nullable":true,
            "x-queryable":true
        },
        "SignatureRole":{
            "title":"Signature Role",
            "maxLength":30,
            "type":"string",
            "description":"Signatory Role Code",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SignatureRoleMeaning":{
            "type":"string",
            "description":"Signatory Role",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SignerSequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"Singer Sequence",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start Date",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Contract Party Contact Flexfields

Type: array

Title: Contract Party Contact Flexfields

The contract party contact flex field resource is used to view, create, update contract party contact flex field information.

Show Source

• Array of: object contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-response

{
    "title":"Contract Party Contact Flexfields",
    "type":"array",
    "description":"The contract party contact flex field resource is used to view, create, update contract party contact flex field information.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-response"
    },
    "x-cardinality":"1"
}

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 : contracts-ContractParty-ContractPartyContact-ContractPartyContactFlexfieldVA-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 90

  Descriptive Flexfield: structure definition of the user descriptive flexfield.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• Id: integer (int64)
  Contract Party Contact Flexfield ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Default Value: 1

  Major Version

{
    "type":"object",
    "properties":{
        "Id":{
            "type":"integer",
            "description":"Contract Party Contact Flexfield ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "MajorVersion":{
            "type":"integer",
            "description":"Major Version",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":90,
            "type":"string",
            "description":"Descriptive Flexfield: structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

Nested Schema : contracts-ContractParty-ContractPartyFlexfieldVA-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 90

  Descriptive Flexfield: structure definition of the user descriptive flexfield.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• Id: integer (int64)
  Contract Party Flexfield ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Default Value: 1

  Major Version

{
    "type":"object",
    "properties":{
        "Id":{
            "type":"integer",
            "description":"Contract Party Flexfield ID",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "MajorVersion":{
            "type":"integer",
            "description":"Major Version",
            "format":"int64",
            "nullable":false,
            "default":1,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":90,
            "type":"string",
            "description":"Descriptive Flexfield: structure definition of the user descriptive flexfield.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

Links

ContractPartyContact

Operation: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyContact

Parameters:

• ContractPartyUniqID: $request.path.ContractPartyUniqID
• contractsUniqID: $request.path.contractsUniqID

The contract party contacts resource is used to view the details of contract party contact. A party contact of a contract is one who is responsible to follow up on the contractual obligations.

ContractPartyFlexfieldVA

Operation: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractParty/{ContractPartyUniqID}/child/ContractPartyFlexfieldVA

Parameters:

• ContractPartyUniqID: $request.path.ContractPartyUniqID
• contractsUniqID: $request.path.contractsUniqID

The contract party flex fields is used to view, create, update contract party flex field information.

Back to Top