Jump to

• Request
• Response

Get a contract request

get

/fscmRestApi/resources/11.13.18.05/contractRequests/{RequestNumber}

Request

Path Parameters

• RequestNumber(required): string
  The alternate unique identifier of the contract request.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : contractRequests-item-response

Type: object

Show Source

• AllPartyName: string
  Title: Party Name

  Read Only: true

  Maximum Length: 360

  The name of the primary party of the contract request.
• AssignedPersonName: string
  Title: Assignee

  Read Only: true

  Maximum Length: 450

  The name of the assignee of the contract request.
• AssigneeFlag: boolean
  Read Only: true

  Indicates if the current user has assignee role.
• AssigneeId: number
  Title: Assignee

  The unique identifier of the contract request assignee.
• AssigneeName: string
  Title: Assignee

  Maximum Length: 80

  Name of the assignee of contract request.
• AssigneeTypeCode: string
  Title: Assignee Type

  Maximum Length: 30

  The code of the assignee type associated with a contract request.
• AttachmentEntityName: string
  Read Only: true

  Maximum Length: 255

  Default Value: OKC_CONTRACT_REQUESTS

  The attachment entity name for the contract.
• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• ChrId: number
  The unique identifier of the contract created through contract request.
• ContactDetails: string
  Title: Contact Details

  Maximum Length: 1995

  The external party contact details of contract request.
• ContractAutoNumberFlag: boolean
  Flag to check if auto numbering enabled for contract type
• ContractBUId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit of contract for the contract request.
• ContractBUName: string
  Title: Business Unit

  Maximum Length: 80

  The name of the business unit of contract created through the contract request.
• ContractEndDate: string (date)
  Title: End Date

  The end date of the contract created through contract request.
• ContractLeId: number
  Title: Legal Entity

  The unique identifier of the legal entity of contract for the contract request.
• ContractLeName: string
  Title: Legal Entity

  Maximum Length: 80

  The name of the legal entity of contract created through the contract request.
• ContractNumber: string
  Title: Contract Number

  Maximum Length: 120

  The contract number created through the contract request.
• ContractStartDate: string (date)
  Title: Start Date

  The start date of the contract created through contract request.
• ContractTypeId: number
  Title: Contract Type

  The unique identifier of the contract type for contract request.
• ContractTypeName: string
  Title: Contract Type

  Maximum Length: 80

  The name of the contract type of contract request.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The currency code for the contract. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup RatedCurrenciesVO.
• CreateContractFlag: boolean
  Read Only: true

  Indicates if the current user can create contract through the contract request.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate for the contract.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code for the contract.
• Description: string
  Title: Description

  Maximum Length: 1995

  The description of the contract request.
• DueDate: string (date)
  Title: Due Date

  The due date of contract request.
• Id: integer
  The unique identifier of the contract request.
• Intent: string
  Maximum Length: 80

  The intent of contract created through the contract request.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date on which the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• LatestContractId: integer
  Read Only: true

  The unique identifier of the current version of the contract created through the contract request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ListAssigneeName: string
  Title: Assignee

  Read Only: true

  Maximum Length: 255

  The name of the contract request assignee.
• ObjectVersionNumber: integer (int32)
  The object version number of the contract request.
• OutcomeMajorVersion: number
  The resultant major version of the contract amended through contract request.
• OwnerId: number
  Title: Owner

  The unique identifier of the contract request owner.
• OwnerName: string
  Title: Owner

  Maximum Length: 80

  Name of the owner of contract request.
• OwnerPersonName: string
  Title: Owner

  Read Only: true

  Maximum Length: 240

  The name of the owner of the contract request.
• PartyContactId: integer (int64)
  Title: Contact Name

  The unique identifier of the external contact of contract created through the contract request.
• PartyContactName: string
  Title: Contact Name

  Maximum Length: 80

  The name of the external contact of contract created through the contract request.
• PartyDetails: string
  Title: Party Details

  Maximum Length: 1995

  The external party details of contract request.
• PrimaryLedgerId: integer (int64)
  The unique identifier of the primary ledger.
• PrimaryPartyId: number
  Title: Party Name

  The unique identifier of the primary party of contract created through contract request.
• PrimaryPartyName: string
  Title: Party Name

  Maximum Length: 80

  The name of the primary party of contract created through the contract request.
• PrimaryPartySupplierId: integer
  Read Only: true

  The supplier identifier of the primary party of the contract request.
• ProvideInformationFlag: boolean
  Read Only: true

  Indicates if the current user can request information for contract request.
• RequestedByPersonId: integer (int64)
  Title: Requester

  The unique identifier of the person who requested contract request.
• RequestedByPersonName: string
  Title: Requester

  Read Only: true

  Maximum Length: 240

  The name of the requester of the contract request.
• RequestedTypeName: string
  Title: Type

  Read Only: true

  Maximum Length: 150

  The name of the contract request type being requested for.
• RequesterFlag: boolean
  Read Only: true

  Indicates if the current user has requester role.
• RequestMajorVersion: number
  The source major version of the contract amended through contract request.
• RequestNumber: string
  Title: Name

  Maximum Length: 120

  The alternate unique identifier of the contract request.
• RequestStatus: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_OKC_DRAFT

  The code indicating the status of the contract request.
• RequestStatusName: string
  Title: Status

  Read Only: true

  Maximum Length: 80

  Name of the status of contract request.
• RequestTypeId: integer (int64)
  Title: Type

  The unique identifier of the contract request type.
• RequestTypeName: string
  Title: Type

  Maximum Length: 150

  The name of the type of contract request.
• smartActions: array Smart Actions
  Title: Smart Actions

  The smart actions resource stores the endpoint and security details for every user action.
• SubmitForApprovalFlag: boolean
  Read Only: true

  Indicates if the current user can submit contract request for approval.
• SubmitForReviewFlag: boolean
  Read Only: true

  Indicates if the current user can submit contract request for review.
• TaskId: string
  Maximum Length: 64

  The unique identifier of the contract request approval human workflow task.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractNumber":{
            "title":"Contract Number",
            "maxLength":120,
            "type":"string",
            "description":"The contract number created through the contract request.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ContractAutoNumberFlag",
                    "ContractTypeId"
                ]
            },
            "x-queryable":true
        },
        "RequestTypeId":{
            "title":"Type",
            "type":"integer",
            "description":"The unique identifier of the contract request type.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate for the contract.",
            "nullable":true,
            "x-queryable":false
        },
        "AssigneeFlag":{
            "type":"boolean",
            "description":"Indicates if the current user has assignee role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyContactName":{
            "title":"Contact Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the external contact of contract created through the contract request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PrimaryPartyId"
                ]
            }
        },
        "RequestStatusName":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"Name of the status of contract request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/contractRequests-smartActions-item-response"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code for the contract.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssigneeId":{
            "title":"Assignee",
            "type":"number",
            "description":"The unique identifier of the contract request assignee.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "AssigneeTypeCode",
                    "RequestTypeId"
                ]
            }
        },
        "ContactDetails":{
            "title":"Contact Details",
            "maxLength":1995,
            "type":"string",
            "description":"The external party contact details of contract request.",
            "nullable":true,
            "x-queryable":false
        },
        "AssignedPersonName":{
            "title":"Assignee",
            "maxLength":450,
            "type":"string",
            "description":"The name of the assignee of the contract request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPartySupplierId":{
            "type":"integer",
            "description":"The supplier identifier of the primary party of the contract request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContractTypeName":{
            "title":"Contract Type",
            "maxLength":80,
            "type":"string",
            "description":"The name of the contract type of contract request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RequestTypeId"
                ]
            }
        },
        "RequestMajorVersion":{
            "type":"number",
            "description":"The source major version of the contract amended through contract request.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllPartyName":{
            "title":"Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the primary party of the contract request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code for the contract. This attribute is used by CRM Extensibility framework. A list of valid values are defined in the lookup RatedCurrenciesVO.",
            "nullable":true,
            "x-queryable":false
        },
        "ListAssigneeName":{
            "title":"Assignee",
            "maxLength":255,
            "type":"string",
            "description":"The name of the contract request assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequesterFlag":{
            "type":"boolean",
            "description":"Indicates if the current user has requester role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryPartyName":{
            "title":"Party Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the primary party of contract created through the contract request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubmitForApprovalFlag":{
            "type":"boolean",
            "description":"Indicates if the current user can submit contract request for approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContractBUId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit of contract for the contract request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "Intent",
                    "RequestTypeId"
                ]
            }
        },
        "RequestedByPersonName":{
            "title":"Requester",
            "maxLength":240,
            "type":"string",
            "description":"The name of the requester of the contract request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutcomeMajorVersion":{
            "type":"number",
            "description":"The resultant major version of the contract amended through contract request.",
            "nullable":true,
            "x-queryable":false
        },
        "SubmitForReviewFlag":{
            "type":"boolean",
            "description":"Indicates if the current user can submit contract request for review.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreateContractFlag":{
            "type":"boolean",
            "description":"Indicates if the current user can create contract through the contract request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerPersonName":{
            "title":"Owner",
            "maxLength":240,
            "type":"string",
            "description":"The name of the owner of the contract request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Id":{
            "type":"integer",
            "description":"The unique identifier of the contract request.",
            "nullable":false,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContractStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the contract created through contract request.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":80,
            "type":"string",
            "description":"Name of the owner of contract request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LatestContractId":{
            "type":"integer",
            "description":"The unique identifier of the current version of the contract created through the contract request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1995,
            "type":"string",
            "description":"The description of the contract request.",
            "nullable":true,
            "x-queryable":false
        },
        "TaskId":{
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the contract request approval human workflow task.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractTypeId":{
            "title":"Contract Type",
            "type":"number",
            "description":"The unique identifier of the contract type for contract request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RequestTypeId"
                ]
            }
        },
        "ContractAutoNumberFlag":{
            "type":"boolean",
            "description":"Flag to check if auto numbering enabled for contract type",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContractTypeId"
                ]
            }
        },
        "ContractLeName":{
            "title":"Legal Entity",
            "maxLength":80,
            "type":"string",
            "description":"The name of the legal entity of contract created through the contract request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ContractBUId",
                    "PrimaryLedgerId"
                ]
            }
        },
        "PrimaryPartyId":{
            "title":"Party Name",
            "type":"number",
            "description":"The unique identifier of the primary party of contract created through contract request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/contractRequests-Attachments-item-response"
            }
        },
        "RequestNumber":{
            "title":"Name",
            "maxLength":120,
            "type":"string",
            "description":"The alternate unique identifier of the contract request.",
            "nullable":false,
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner",
            "type":"number",
            "description":"The unique identifier of the contract request owner.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the contract request.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "RequestedTypeName":{
            "title":"Type",
            "maxLength":150,
            "type":"string",
            "description":"The name of the contract request type being requested for.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"The due date of contract request.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AssigneeName":{
            "title":"Assignee",
            "maxLength":80,
            "type":"string",
            "description":"Name of the assignee of contract request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AssigneeTypeCode"
                ]
            }
        },
        "RequestTypeName":{
            "title":"Type",
            "maxLength":150,
            "type":"string",
            "description":"The name of the type of contract request.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssigneeTypeCode":{
            "title":"Assignee Type",
            "maxLength":30,
            "type":"string",
            "description":"The code of the assignee type associated with a contract request.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RequestTypeId"
                ]
            },
            "x-queryable":true
        },
        "ContractEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the contract created through contract request.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RequestedByPersonId":{
            "title":"Requester",
            "type":"integer",
            "description":"The unique identifier of the person who requested contract request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ChrId":{
            "type":"number",
            "description":"The unique identifier of the contract created through contract request.",
            "nullable":true,
            "x-queryable":false
        },
        "Intent":{
            "maxLength":80,
            "type":"string",
            "description":"The intent of contract created through the contract request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "RequestTypeName"
                ]
            }
        },
        "PartyContactId":{
            "title":"Contact Name",
            "type":"integer",
            "description":"The unique identifier of the external contact of contract created through the contract request.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "PrimaryPartyId"
                ]
            }
        },
        "ContractLeId":{
            "title":"Legal Entity",
            "type":"number",
            "description":"The unique identifier of the legal entity of contract for the contract request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContractBUId",
                    "PrimaryLedgerId"
                ]
            }
        },
        "ProvideInformationFlag":{
            "type":"boolean",
            "description":"Indicates if the current user can request information for contract request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyDetails":{
            "title":"Party Details",
            "maxLength":1995,
            "type":"string",
            "description":"The external party details of contract request.",
            "nullable":true,
            "x-queryable":false
        },
        "ContractBUName":{
            "title":"Business Unit",
            "maxLength":80,
            "type":"string",
            "description":"The name of the business unit of contract created through the contract request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo"
            }
        },
        "AttachmentEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The attachment entity name for the contract.",
            "nullable":true,
            "readOnly":true,
            "default":"OKC_CONTRACT_REQUESTS",
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the status of the contract request.",
            "nullable":false,
            "default":"ORA_OKC_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PrimaryLedgerId":{
            "type":"integer",
            "description":"The unique identifier of the primary ledger.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":80
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object contractRequests-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/contractRequests-Attachments-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 : Smart Actions

Type: array

Title: Smart Actions

The smart actions resource stores the endpoint and security details for every user action.

Show Source

• Array of: object contractRequests-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/contractRequests-smartActions-item-response"
    }
}

Nested Schema : contractRequests-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

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

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : contractRequests-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  Consumer-friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  REST Resources the action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The REST endpoint to perform the action.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  List of applications that this action can be used in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Boolean type indicating if this action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  HTTP method to use with HREF.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates if smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Boolean type indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  Attributes to be updated when the Actions UI is launched.
• UserActionId: integer (int64)
  Title: User Action ID

  Uniquely identifies the action. For internal use.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  Uniquely identifies the action with a name. For internal use.
• UserActionNavigation: array User Action Navigations
  Title: User Action Navigations

  The user action navigation resource stores UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  Number to indicate priority of the action.
• UserActionRequestPayload: array User Action Request Payloads
  Title: User Action Request Payloads

  The user action request payload resource stores the payload metadata of user action requests.
• UserActionURLBinding: array User Action URL Bindings
  Title: User Action URL Bindings

  The user action URL binding resource stores the user action URL binding metadata.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"User Action URL Bindings",
            "type":"array",
            "description":"The user action URL binding resource stores the user action URL binding metadata.",
            "items":{
                "$ref":"#/components/schemas/contractRequests-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"User Action Navigations",
            "type":"array",
            "description":"The user action navigation resource stores UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/contractRequests-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"Uniquely identifies the action. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"User Action Request Payloads",
            "type":"array",
            "description":"The user action request payload resource stores the payload metadata of user action requests.",
            "items":{
                "$ref":"#/components/schemas/contractRequests-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":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 : User Action Navigations

Type: array

Title: User Action Navigations

The user action navigation resource stores UI navigation metadata striped by app usage.

Show Source

• Array of: object contractRequests-smartActions-UserActionNavigation-item-response

{
    "title":"User Action Navigations",
    "type":"array",
    "description":"The user action navigation resource stores UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/contractRequests-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : User Action Request Payloads

Type: array

Title: User Action Request Payloads

The user action request payload resource stores the payload metadata of user action requests.

Show Source

• Array of: object contractRequests-smartActions-UserActionRequestPayload-item-response

{
    "title":"User Action Request Payloads",
    "type":"array",
    "description":"The user action request payload resource stores the payload metadata of user action requests.",
    "items":{
        "$ref":"#/components/schemas/contractRequests-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : User Action URL Bindings

Type: array

Title: User Action URL Bindings

The user action URL binding resource stores the user action URL binding metadata.

Show Source

• Array of: object contractRequests-smartActions-UserActionURLBinding-item-response

{
    "title":"User Action URL Bindings",
    "type":"array",
    "description":"The user action URL binding resource stores the user action URL binding metadata.",
    "items":{
        "$ref":"#/components/schemas/contractRequests-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : contractRequests-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavId: integer (int64)
  Title: Primary Key

  Primary key for the user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"Primary key for the user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"Application usage.",
            "nullable":false,
            "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 : contractRequests-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadId: integer (int64)
  Uniquely identifies the payload for smart actions. For internal use.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":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 : contractRequests-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  This is a hint for processing the Url Binding runtime.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean indicator.
• URLBindingId: integer (int64)
  Uniquely identifies the URL Bind for smart actions. For internal use.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 256

  For action REST endpoints that require runtime binding, this is the key in the key value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 1000

  For action REST endpoints that require runtime binding, this is the value in the key value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"Uniquely identifies the URL Bind for smart actions. For internal use.",
            "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"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false,
            "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"
    }
}

Links

AssigneeTypeLookupVOVA1

Operation: /fscmRestApi/resources/11.13.18.05/assigneeTypesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: AssigneeTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

AssigneeVOVA1

Operation: /fscmRestApi/resources/11.13.18.05/contractRequestAssigneesLOV

Parameters:

• finder: ObjectCodeFinder%3BbindObjectCode%3D{AssigneeTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: AssigneeName; Target Attribute: Name
• Display Attribute: Name

Attachments

Operation: /fscmRestApi/resources/11.13.18.05/contractRequests/{RequestNumber}/child/Attachments

Parameters:

• RequestNumber: $request.path.RequestNumber

The attachments resource is used to view, create, and update attachments.

ContractRequestConTypeVOVA1

Operation: /fscmRestApi/resources/11.13.18.05/contractRequestContractTypesLOV

Parameters:

• finder: RequestTypeConTypeFinder%3BbindRequestTypeId%3D{RequestTypeId}

The following properties are defined on the LOV link relation:

• Source Attribute: ContractTypeName; Target Attribute: Name
• Display Attribute: Name

ContractRequestConTypeVOVA2

Operation: /fscmRestApi/resources/11.13.18.05/contractRequestContractTypesLOV

Parameters:

• finder: RequestTypeConTypeFinder%3BbindRequestTypeId%3D{RequestTypeId}

The following properties are defined on the LOV link relation:

• Source Attribute: ContractTypeId; Target Attribute: ContractTypeId
• Display Attribute: Name

ContractRequestLegalEntityVOVA

Operation: /fscmRestApi/resources/11.13.18.05/contractRequestLegalEntitiesLOV

Parameters:

• finder: LedgerBasedFinder%3BbindPrimaryLedgerId%3D{PrimaryLedgerId}

The following properties are defined on the LOV link relation:

• Source Attribute: ContractLeName; Target Attribute: LegalEntityIdentifier
• Display Attribute: LegalEntityIdentifier, LegalEntityName

ContractRequestPartyVOVA1

Operation: /fscmRestApi/resources/11.13.18.05/contractRequestPartiesLOV

Parameters:

• finder: IntentBasedFinder%3BbindPartyIntent%3D{Intent}

The following properties are defined on the LOV link relation:

• Source Attribute: PrimaryPartyName; Target Attribute: PartyName
• Display Attribute: PartyName, PartyNumber

ContractRequestPartyVOVA3

Operation: /fscmRestApi/resources/11.13.18.05/contractRequestPartiesLOV

Parameters:

• finder: IntentBasedFinder%3BbindPartyIntent%3D{Intent}

The following properties are defined on the LOV link relation:

• Source Attribute: PrimaryPartyId; Target Attribute: PartyId
• Display Attribute: PartyName

ContractRequestTypeVOVA

Operation: /fscmRestApi/resources/11.13.18.05/contractRequestTypesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: RequestTypeName; Target Attribute: Name
• Display Attribute: Name

ContractRequestTypeVOVA2

Operation: /fscmRestApi/resources/11.13.18.05/contractRequestTypesLOV

Parameters:

• finder: RequestTypeEffectiveDated

The following properties are defined on the LOV link relation:

• Source Attribute: RequestTypeId; Target Attribute: Id
• Display Attribute: Name

CurrencyPVOVA

Operation: /fscmRestApi/resources/11.13.18.05/currenciesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
• Display Attribute: Name

FinFunBusinessUnitVOVA1

Operation: /fscmRestApi/resources/11.13.18.05/finBusinessUnitsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: ContractBUName; Target Attribute: BusinessUnitName
• Display Attribute: BusinessUnitName

LookupPVOVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_OKC_REQUEST_STATUS

The following properties are defined on the LOV link relation:

• Source Attribute: RequestStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

PcontactVOVA1

Operation: /fscmRestApi/resources/11.13.18.05/partyContactsLOV

Parameters:

• finder: PartyStatusFinder%3BPartyIdVar%3D{PrimaryPartyId}%2CStatusVar%3DA

The following properties are defined on the LOV link relation:

• Source Attribute: PartyContactName; Target Attribute: ContactName
• Display Attribute: ContactName, Department, EmailAddress, JobTitle

PcontactVOVA2

Operation: /fscmRestApi/resources/11.13.18.05/partyContactsLOV

Parameters:

• finder: PartyStatusFinder%3BPartyIdVar%3D{PrimaryPartyId}%2CStatusVar%3DA

The following properties are defined on the LOV link relation:

• Source Attribute: PartyContactId; Target Attribute: ContactId
• Display Attribute: ContactName

PersonLovPVOVA

Operation: /fscmRestApi/resources/11.13.18.05/contractRequestOwnersLOV

The following properties are defined on the LOV link relation:

• Source Attribute: OwnerName; Target Attribute: DisplayName
• Display Attribute: DisplayName

PersonLovPVOVA2

Operation: /fscmRestApi/resources/11.13.18.05/contractRequestOwnersLOV

The following properties are defined on the LOV link relation:

• Source Attribute: OwnerId; Target Attribute: PersonId
• Display Attribute: DisplayName

smartActions

Operation: /fscmRestApi/resources/11.13.18.05/contractRequests/{RequestNumber}/child/smartActions

Parameters:

• RequestNumber: $request.path.RequestNumber

The smart actions resource stores the endpoint and security details for every user action.

Back to Top