Jump to

• Request
• Response
• Examples

Create procurement agents

post

/fscmRestApi/resources/11.13.18.05/procurementAgents

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  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

• AccessLevelToOtherAgentsAgreements: string
  Access level to the documents owned by other procurement agents to manage purchase agreements. Valid values include None, View, and Full. The default value is None.
• AccessLevelToOtherAgentsChecklists: string
  Access level to the documents owned by other procurement agents to manage compliance checklists. The possible values are None, View, and Full. The default value is None.
• AccessLevelToOtherAgentsNegotiations: string
  Access level to the documents owned by other procurement agents to manage negotiations. Valid values include None, View, and Full. The default value is None.
• AccessLevelToOtherAgentsOrders: string
  Access level to documents owned by other procurement agents to manage purchase orders. Valid values include None, View, and Full. The default value is None.
• AccessLevelToOtherAgentsQualifications: string
  Access level to the documents owned by other procurement agents to manage supplier qualifications. Valid values include None, View, and Full. The default value is None.
• AccessLevelToOtherAgentsRequisitions: string
  Access level to the documents owned by other procurement agents to manage purchase requisitions. The possible values are None, View, and Full. The default value is None.
• AccessLevelToOtherAgentsSourcingPrograms: string
  Access level to the documents owned by other procurement agents to manage sourcing programs. Valid values include None, View, and Full. The default value is None.
• Agent: string
  Title: Name

  Maximum Length: 240

  Name of the agent. The name of the agent has to be provided in the following format: Last Name, First Name.
• AgentEmail: string
  Title: Email

  Maximum Length: 240

  Email address of the agent.
• AgentId: integer (int64)
  Value that uniquely identifies the agent.
• AnalyzeSpendAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to analyze spend. If false, then the application does not allow this access. The default value is false.
• AssignmentId: integer (int64)
  Value that uniquely identifies the procurement agent assignment.
• DefaultPrinter: string
  Maximum Length: 80

  Default printer for the procurement agent.
• DefaultRequisitioningBU: string
  Title: Name

  Maximum Length: 240

  Name of the default requisitioning business unit.
• DefaultRequisitioningBUId: integer (int64)
  Value that uniquely identifies the default requisitioning business unit.
• ManageAgreementsAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage purchase agreements. If false, then the application does not allow this access. The default value is false.
• ManageAslAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage entries on the approved supplier list. If false, then the application does not allow this access. The default value is false.
• ManageCatalogContentAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage catalog content. If false, then the application does not allow this access. The default value is false.
• ManageChecklistsAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage compliance checklists. If false, then the application doesn't allow this access. The default value is false.
• ManageNegotiationsAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage negotiations. If false, then the application does not allow this access. The default value is false.
• ManageOrdersAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage purchase orders. If false, then the application does not allow this access. The default value is false.
• ManageQualificationsAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage supplier qualifications. If false, then the application does not allow this access. The default value is false.
• ManageRequisitionsAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage purchase requisitions. If false, then the application does not allow this access. The default value is false.
• ManageSourcingProgramsAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage sourcing programs. If false, then the application does not allow this access. The default value is false.
• ManageSuppliersAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage suppliers. If false, then the application does not allow this access. The default value is false.
• ProcurementBU: string
  Title: Name

  Maximum Length: 240

  Name of the procurement business unit where the agent is assigned.
• ProcurementBUId: integer (int64)
  Value that uniquely identifies the procurement business unit.
• Status: string
  Title: Meaning

  Maximum Length: 80

  Status of the procurement agent. Valid values include Inactive and Active. The default value is Active.
• StatusCode: string
  Title: Status

  Maximum Length: 1

  Default Value: Y

  Abbreviation that identifies the status of the procurement agent. Contains one of the following values. Y: status of procurement agent is active. N: status of procurement agent is inactive. The default value is Y.

{
    "type":"object",
    "properties":{
        "ManageOrdersAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage purchase orders. If false, then the application does not allow this access. The default value is false.",
            "nullable":false
        },
        "AccessLevelToOtherAgentsQualifications":{
            "type":"string",
            "description":"Access level to the documents owned by other procurement agents to manage supplier qualifications. Valid values include None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultPrinter":{
            "maxLength":"80",
            "type":"string",
            "description":"Default printer for the procurement agent.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ManageRequisitionsAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage purchase requisitions. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "ManageNegotiationsAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage negotiations. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "AccessLevelToOtherAgentsNegotiations":{
            "type":"string",
            "description":"Access level to the documents owned by other procurement agents to manage negotiations. Valid values include None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessLevelToOtherAgentsOrders":{
            "type":"string",
            "description":"Access level to documents owned by other procurement agents to manage purchase orders. Valid values include None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ManageAslAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage entries on the approved supplier list. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"Abbreviation that identifies the status of the procurement agent. Contains one of the following values. Y: status of procurement agent is active. N: status of procurement agent is inactive. The default value is Y.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessLevelToOtherAgentsAgreements":{
            "type":"string",
            "description":"Access level to the documents owned by other procurement agents to manage purchase agreements. Valid values include None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AgentEmail":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email address of the agent.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement agent assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DefaultRequisitioningBU":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the default requisitioning business unit.",
            "nullable":true,
            "x-queryable":false
        },
        "AgentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the agent.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ManageSourcingProgramsAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage sourcing programs. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "ProcurementBU":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the procurement business unit where the agent is assigned.",
            "nullable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "Status":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the procurement agent. Valid values include Inactive and Active. The default value is Active.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Agent":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the agent. The name of the agent has to be provided in the following format: Last Name, First Name.",
            "nullable":true
        },
        "ManageAgreementsAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage purchase agreements. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "AnalyzeSpendAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to analyze spend. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "AccessLevelToOtherAgentsSourcingPrograms":{
            "type":"string",
            "description":"Access level to the documents owned by other procurement agents to manage sourcing programs. Valid values include None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultRequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default requisitioning business unit.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ManageCatalogContentAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage catalog content. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "ManageSuppliersAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage suppliers. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "AccessLevelToOtherAgentsRequisitions":{
            "type":"string",
            "description":"Access level to the documents owned by other procurement agents to manage purchase requisitions. The possible values are None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ManageChecklistsAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage compliance checklists. If false, then the application doesn't allow this access. The default value is false.",
            "nullable":false
        },
        "ManageQualificationsAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage supplier qualifications. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "AccessLevelToOtherAgentsChecklists":{
            "type":"string",
            "description":"Access level to the documents owned by other procurement agents to manage compliance checklists. The possible values are None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : procurementAgents-item-response

Type: object

Show Source

• AccessLevelToOtherAgentsAgreements: string
  Access level to the documents owned by other procurement agents to manage purchase agreements. Valid values include None, View, and Full. The default value is None.
• AccessLevelToOtherAgentsChecklists: string
  Access level to the documents owned by other procurement agents to manage compliance checklists. The possible values are None, View, and Full. The default value is None.
• AccessLevelToOtherAgentsNegotiations: string
  Access level to the documents owned by other procurement agents to manage negotiations. Valid values include None, View, and Full. The default value is None.
• AccessLevelToOtherAgentsOrders: string
  Access level to documents owned by other procurement agents to manage purchase orders. Valid values include None, View, and Full. The default value is None.
• AccessLevelToOtherAgentsQualifications: string
  Access level to the documents owned by other procurement agents to manage supplier qualifications. Valid values include None, View, and Full. The default value is None.
• AccessLevelToOtherAgentsRequisitions: string
  Access level to the documents owned by other procurement agents to manage purchase requisitions. The possible values are None, View, and Full. The default value is None.
• AccessLevelToOtherAgentsSourcingPrograms: string
  Access level to the documents owned by other procurement agents to manage sourcing programs. Valid values include None, View, and Full. The default value is None.
• Agent: string
  Title: Name

  Maximum Length: 240

  Name of the agent. The name of the agent has to be provided in the following format: Last Name, First Name.
• AgentEmail: string
  Title: Email

  Maximum Length: 240

  Email address of the agent.
• AgentId: integer (int64)
  Value that uniquely identifies the agent.
• AnalyzeSpendAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to analyze spend. If false, then the application does not allow this access. The default value is false.
• AssignmentId: integer (int64)
  Value that uniquely identifies the procurement agent assignment.
• DefaultPrinter: string
  Maximum Length: 80

  Default printer for the procurement agent.
• DefaultRequisitioningBU: string
  Title: Name

  Maximum Length: 240

  Name of the default requisitioning business unit.
• DefaultRequisitioningBUId: integer (int64)
  Value that uniquely identifies the default requisitioning business unit.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManageAgreementsAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage purchase agreements. If false, then the application does not allow this access. The default value is false.
• ManageAslAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage entries on the approved supplier list. If false, then the application does not allow this access. The default value is false.
• ManageCatalogContentAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage catalog content. If false, then the application does not allow this access. The default value is false.
• ManageChecklistsAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage compliance checklists. If false, then the application doesn't allow this access. The default value is false.
• ManageNegotiationsAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage negotiations. If false, then the application does not allow this access. The default value is false.
• ManageOrdersAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage purchase orders. If false, then the application does not allow this access. The default value is false.
• ManageQualificationsAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage supplier qualifications. If false, then the application does not allow this access. The default value is false.
• ManageRequisitionsAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage purchase requisitions. If false, then the application does not allow this access. The default value is false.
• ManageSourcingProgramsAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage sourcing programs. If false, then the application does not allow this access. The default value is false.
• ManageSuppliersAllowedFlag: boolean
  Title: Allowed

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage suppliers. If false, then the application does not allow this access. The default value is false.
• ProcurementBU: string
  Title: Name

  Maximum Length: 240

  Name of the procurement business unit where the agent is assigned.
• ProcurementBUId: integer (int64)
  Value that uniquely identifies the procurement business unit.
• Status: string
  Title: Meaning

  Maximum Length: 80

  Status of the procurement agent. Valid values include Inactive and Active. The default value is Active.
• StatusCode: string
  Title: Status

  Maximum Length: 1

  Default Value: Y

  Abbreviation that identifies the status of the procurement agent. Contains one of the following values. Y: status of procurement agent is active. N: status of procurement agent is inactive. The default value is Y.

{
    "type":"object",
    "properties":{
        "ManageOrdersAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage purchase orders. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "AccessLevelToOtherAgentsQualifications":{
            "type":"string",
            "description":"Access level to the documents owned by other procurement agents to manage supplier qualifications. Valid values include None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultPrinter":{
            "maxLength":"80",
            "type":"string",
            "description":"Default printer for the procurement agent.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ManageRequisitionsAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage purchase requisitions. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "ManageNegotiationsAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage negotiations. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "AccessLevelToOtherAgentsNegotiations":{
            "type":"string",
            "description":"Access level to the documents owned by other procurement agents to manage negotiations. Valid values include None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessLevelToOtherAgentsOrders":{
            "type":"string",
            "description":"Access level to documents owned by other procurement agents to manage purchase orders. Valid values include None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ManageAslAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage entries on the approved supplier list. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"1",
            "type":"string",
            "description":"Abbreviation that identifies the status of the procurement agent. Contains one of the following values. Y: status of procurement agent is active. N: status of procurement agent is inactive. The default value is Y.",
            "nullable":false,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccessLevelToOtherAgentsAgreements":{
            "type":"string",
            "description":"Access level to the documents owned by other procurement agents to manage purchase agreements. Valid values include None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AgentEmail":{
            "title":"Email",
            "maxLength":"240",
            "type":"string",
            "description":"Email address of the agent.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement agent assignment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DefaultRequisitioningBU":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the default requisitioning business unit.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AgentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the agent.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ManageSourcingProgramsAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage sourcing programs. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "ProcurementBU":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the procurement business unit where the agent is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Status of the procurement agent. Valid values include Inactive and Active. The default value is Active.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Agent":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the agent. The name of the agent has to be provided in the following format: Last Name, First Name.",
            "nullable":true,
            "x-queryable":true
        },
        "ManageAgreementsAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage purchase agreements. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "AnalyzeSpendAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to analyze spend. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "AccessLevelToOtherAgentsSourcingPrograms":{
            "type":"string",
            "description":"Access level to the documents owned by other procurement agents to manage sourcing programs. Valid values include None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DefaultRequisitioningBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default requisitioning business unit.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ManageCatalogContentAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage catalog content. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "ManageSuppliersAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage suppliers. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "AccessLevelToOtherAgentsRequisitions":{
            "type":"string",
            "description":"Access level to the documents owned by other procurement agents to manage purchase requisitions. The possible values are None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ManageChecklistsAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage compliance checklists. If false, then the application doesn't allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "ManageQualificationsAllowedFlag":{
            "title":"Allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the application allows the procurement agent to manage supplier qualifications. If false, then the application does not allow this access. The default value is false.",
            "nullable":false,
            "x-queryable":false
        },
        "AccessLevelToOtherAgentsChecklists":{
            "type":"string",
            "description":"Access level to the documents owned by other procurement agents to manage compliance checklists. The possible values are None, View, and Full. The default value is None.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following examples describe how to create one or more procurement agents.

Example 1 cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
https://servername/fscmRestApi/resources/version/procurementAgents"

Example 1 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the records that it creates. In this example, Richard Johnson, with agent ID 300100008259523 is created as a procurement agent for Vision Operations.

{
     "AgentId": 300100008259523,
     "ProcurementBUId": 1016,
     "Status": "Active",
     "DefaultRequisitioningBU": null,
     "DefaultRequisitioningBUId": null,
     "DefaultPrinter": null,
     "ManageRequisitionsAllowedFlag": true,
     "AccessLevelToOtherAgentsRequisitions": "View",
     "ManageOrdersAllowedFlag": true,
     "AccessLevelToOtherAgentsOrders": "Full",
     "ManageAgreementsAllowedFlag": false,
     "AccessLevelToOtherAgentsAgreements": "None",
     "ManageNegotiationsAllowedFlag": false,
     "AccessLevelToOtherAgentsNegotiations": "None",
     "ManageSourcingProgramsAllowedFlag": false,
     "AccessLevelToOtherAgentsSourcingPrograms": "None",
     "ManageCatalogContentAllowedFlag": false,
     "ManageSuppliersAllowedFlag": false,
     "ManageQualificationsAllowedFlag": false,
     "AccessLevelToOtherAgentsQualifications": "None",
     "ManageAslAllowedFlag": false,
     "AnalyzeSpendAllowedFlag": false
}

Example 1 Response Body

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

{
  "AssignmentId" : 300100124649102,
  "Agent" : "Johnson, Richard",
  "AgentId" : 300100008259523,
  "AgentEmail" : "[e-mail]",
  "ProcurementBU" : "Vision Operations",
  "ProcurementBUId" : 1016,
  "Status" : "Active",
  "StatusCode" : "Y",
  "DefaultRequisitioningBU" : null,
  "DefaultRequisitioningBUId" : null,
  "DefaultPrinter" : null,
  "ManageRequisitionsAllowedFlag" : true,
  "AccessLevelToOtherAgentsRequisitions" : "View",
  "ManageOrdersAllowedFlag" : true,
  "AccessLevelToOtherAgentsOrders" : "Full",
  "ManageAgreementsAllowedFlag" : false,
  "AccessLevelToOtherAgentsAgreements" : "None",
  "ManageNegotiationsAllowedFlag" : false,
  "AccessLevelToOtherAgentsNegotiations" : "None",
  "ManageSourcingProgramsAllowedFlag" : false,
  "AccessLevelToOtherAgentsSourcingPrograms" : "None",
  "ManageCatalogContentAllowedFlag" : false,
  "ManageSuppliersAllowedFlag" : false,
  "ManageQualificationsAllowedFlag" : false,
  "AccessLevelToOtherAgentsQualifications" : "None",
  "ManageAslAllowedFlag" : false,
  "AnalyzeSpendAllowedFlag" : false,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102",
    "name" : "procurementAgents",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000B77040000000B737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E00020000000278"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102",
    "name" : "procurementAgents",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/StatusAccessor",
    "name" : "StatusAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/ActivePersonAccessor",
    "name" : "ActivePersonAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/PrinterAccessor",
    "name" : "PrinterAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/AccessOthersLevelNoModifyActionAccessor",
    "name" : "AccessOthersLevelNoModifyActionAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/AccessOthersLevelAccessor",
    "name" : "AccessOthersLevelAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/ProcurementBUAccessor",
    "name" : "ProcurementBUAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/DefaultReqBuAccessor",
    "name" : "DefaultReqBuAccessor",
    "kind" : "collection"
  }]
}

Example 2 cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.batch+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version"

Example 2 Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the records that it creates. In this example, two procurement agents are created.

{
   "parts":[
      {
         "id":"part1",
         "path":"/procurementAgents",
         "operation":"create",
         "payload":{
            "AgentId": 300100008259468,
            "ProcurementBUId":  1016,
            "Status": "Active",
            "DefaultRequisitioningBU": null,
            "DefaultRequisitioningBUId": null,
            "DefaultPrinter": null,
            "ManageRequisitionsAllowedFlag": true,
            "AccessLevelToOtherAgentsRequisitions": "View",
            "ManageOrdersAllowedFlag": true,
            "AccessLevelToOtherAgentsOrders": "Full",
            "ManageAgreementsAllowedFlag": false,
            "AccessLevelToOtherAgentsAgreements": "None",
            "ManageNegotiationsAllowedFlag": false,
            "AccessLevelToOtherAgentsNegotiations": "None",
            "ManageSourcingProgramsAllowedFlag": false,
            "AccessLevelToOtherAgentsSourcingPrograms": "None",
            "ManageCatalogContentAllowedFlag": false,
            "ManageSuppliersAllowedFlag": false,
            "ManageQualificationsAllowedFlag": false,
            "AccessLevelToOtherAgentsQualifications": "None",
            "ManageAslAllowedFlag": false,
            "AnalyzeSpendAllowedFlag": false
            }
      },
      {
         "id":"part2",
         "path":"/procurementAgents",
         "operation":"create",
         "payload":{
            "AgentId": 300100037119510,
            "ProcurementBUId": 1016,
            "Status": "Active",
            "DefaultRequisitioningBU": null,
            "DefaultRequisitioningBUId": null,
            "DefaultPrinter": null,
            "ManageRequisitionsAllowedFlag": true,
            "AccessLevelToOtherAgentsRequisitions": "View",
            "ManageOrdersAllowedFlag": true,
            "AccessLevelToOtherAgentsOrders": "Full",
            "ManageAgreementsAllowedFlag": false,
            "AccessLevelToOtherAgentsAgreements": "None",
            "ManageNegotiationsAllowedFlag": false,
            "AccessLevelToOtherAgentsNegotiations": "None",
            "ManageSourcingProgramsAllowedFlag": false,
            "AccessLevelToOtherAgentsSourcingPrograms": "None",
            "ManageCatalogContentAllowedFlag": false,
            "ManageSuppliersAllowedFlag": false,
            "ManageQualificationsAllowedFlag": false,
            "AccessLevelToOtherAgentsQualifications": "None",
            "ManageAslAllowedFlag": false,
            "AnalyzeSpendAllowedFlag": false
           
         }
      }
   ]
}

Example 2 Response Body

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

[
[
{
  "AssignmentId" : 300100124649102,
  "Agent" : "Brown, John",
  "AgentId" : 300100008259468,
  "AgentEmail" : "[e-mail]",
  "ProcurementBU" : "Vision Operations",
  "ProcurementBUId" : 1016,
  "Status" : "Active",
  "StatusCode" : "Y",
  "DefaultRequisitioningBU" : null,
  "DefaultRequisitioningBUId" : null,
  "DefaultPrinter" : null,
  "ManageRequisitionsAllowedFlag" : true,
  "AccessLevelToOtherAgentsRequisitions" : "View",
  "ManageOrdersAllowedFlag" : true,
  "AccessLevelToOtherAgentsOrders" : "Full",
  "ManageAgreementsAllowedFlag" : false,
  "AccessLevelToOtherAgentsAgreements" : "None",
  "ManageNegotiationsAllowedFlag" : false,
  "AccessLevelToOtherAgentsNegotiations" : "None",
  "ManageSourcingProgramsAllowedFlag" : false,
  "AccessLevelToOtherAgentsSourcingPrograms" : "None",
  "ManageCatalogContentAllowedFlag" : false,
  "ManageSuppliersAllowedFlag" : false,
  "ManageQualificationsAllowedFlag" : false,
  "AccessLevelToOtherAgentsQualifications" : "None",
  "ManageAslAllowedFlag" : false,
  "AnalyzeSpendAllowedFlag" : false,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102",
    "name" : "procurementAgents",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000B77040000000B737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E00020000000278"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102",
    "name" : "procurementAgents",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/StatusAccessor",
    "name" : "StatusAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/ActivePersonAccessor",
    "name" : "ActivePersonAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/PrinterAccessor",
    "name" : "PrinterAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/AccessOthersLevelNoModifyActionAccessor",
    "name" : "AccessOthersLevelNoModifyActionAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/AccessOthersLevelAccessor",
    "name" : "AccessOthersLevelAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/ProcurementBUAccessor",
    "name" : "ProcurementBUAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649102/lov/DefaultReqBuAccessor",
    "name" : "DefaultReqBuAccessor",
    "kind" : "collection"
  }]
},
{
  "AssignmentId" : 300100124649103,
  "Agent" : "Johnson, John",
  "AgentId" : 300100037119510,
  "AgentEmail" : "[e-mail]",
  "ProcurementBU" : "Vision Operations",
  "ProcurementBUId" : 1016,
  "Status" : "Active",
  "StatusCode" : "Y",
  "DefaultRequisitioningBU" : null,
  "DefaultRequisitioningBUId" : null,
  "DefaultPrinter" : null,
  "ManageRequisitionsAllowedFlag" : true,
  "AccessLevelToOtherAgentsRequisitions" : "View",
  "ManageOrdersAllowedFlag" : true,
  "AccessLevelToOtherAgentsOrders" : "Full",
  "ManageAgreementsAllowedFlag" : false,
  "AccessLevelToOtherAgentsAgreements" : "None",
  "ManageNegotiationsAllowedFlag" : false,
  "AccessLevelToOtherAgentsNegotiations" : "None",
  "ManageSourcingProgramsAllowedFlag" : false,
  "AccessLevelToOtherAgentsSourcingPrograms" : "None",
  "ManageCatalogContentAllowedFlag" : false,
  "ManageSuppliersAllowedFlag" : false,
  "ManageQualificationsAllowedFlag" : false,
  "AccessLevelToOtherAgentsQualifications" : "None",
  "ManageAslAllowedFlag" : false,
  "AnalyzeSpendAllowedFlag" : false,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103",
    "name" : "procurementAgents",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000B77040000000B737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E00020000000278"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103",
    "name" : "procurementAgents",
    "kind" : "item"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103/lov/StatusAccessor",
    "name" : "StatusAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103/lov/ActivePersonAccessor",
    "name" : "ActivePersonAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103/lov/PrinterAccessor",
    "name" : "PrinterAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103/lov/AccessOthersLevelNoModifyActionAccessor",
    "name" : "AccessOthersLevelNoModifyActionAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103/lov/AccessOthersLevelAccessor",
    "name" : "AccessOthersLevelAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version>/procurementAgents/300100124649103/lov/ProcurementBUAccessor",
    "name" : "ProcurementBUAccessor",
    "kind" : "collection"
  }, {
    "rel" : "lov",
    "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/300100124649103/lov/DefaultReqBuAccessor",
    "name" : "DefaultReqBuAccessor",
    "kind" : "collection"
  }]
}
]
]

Back to Top