Get all procurement agents

get

/fscmRestApi/resources/11.13.18.05/procurementAgents

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • ByAssignmentId: Find procurement agents according to the assignment.
      Finder Variables:
      • AssignmentId; integer; Value that uniquely identifies the procurement agent.
    • PrimaryKey: Find procurement agents according to the assignment identifier.
      Finder Variables:
      • AssignmentId; integer; Value that uniquely identifies the procurement agent.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • Agent; string; Name of the agent. The name of the agent has to be provided in the following format: Last Name, First Name.
    • AgentEmail; string; Email address of the agent.
    • AgentId; integer; Value that uniquely identifies the agent.
    • AssignmentId; integer; Value that uniquely identifies the procurement agent assignment.
    • ManageChecklistsAllowedFlag; boolean; 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.
    • ManageOrdersAllowedFlag; boolean; 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.
    • ProcurementBU; string; Name of the procurement business unit where the agent is assigned.
    • ProcurementBUId; integer; Value that uniquely identifies the procurement business unit.
    • Status; string; Status of the procurement agent. Valid values include Inactive and Active. The default value is Active.
    • StatusCode; string; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : procurementAgents-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Email
    Maximum Length: 240
    Email address of the agent.
  • Value that uniquely identifies the agent.
  • 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.
  • Value that uniquely identifies the procurement agent assignment.
  • Maximum Length: 80
    Default printer for the procurement agent.
  • Title: Name
    Maximum Length: 240
    Name of the default requisitioning business unit.
  • Value that uniquely identifies the default requisitioning business unit.
  • Links
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: Name
    Maximum Length: 240
    Name of the procurement business unit where the agent is assigned.
  • Value that uniquely identifies the procurement business unit.
  • Title: Meaning
    Maximum Length: 80
    Status of the procurement agent. Valid values include Inactive and Active. The default value is Active.
  • 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.
Back to Top

Examples

This example describes how to get all procurement agents.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/procurementAgents"

Example Response Body

The following shows an example of the response body in JSON format.

{
     "items" : [
{
  "AssignmentId" : 300100124649102,
  "Agent" : "Brown, John",
  "AgentId" : 300100008259468,
  "AgentEmail" : "john.brown@example.com",
  "ProcurementBU" : "Vision Operations",
  "ProcurementBUId" : 1016,
  "Status" : "Active",
  "StatusCode" : "Y",
  "DefaultRequisitioningBU" : null,
  "DefaultRequisitioningBUId" : null,
  "DefaultPrinter" : null,
  "ManageRequisitionsAllowedFlag" : false,
  "AccessLevelToOtherAgentsRequisitions" : "None",
  "ManageOrdersAllowedFlag" : false,
  "AccessLevelToOtherAgentsOrders" : "None",
  "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" : "john.johnson@example.com",
  "ProcurementBU" : "Vision Operations BU",
  "ProcurementBUId" : 300100009422512,
  "Status" : "Active",
  "StatusCode" : "Y",
  "DefaultRequisitioningBU" : null,
  "DefaultRequisitioningBUId" : null,
  "DefaultPrinter" : null,
  "ManageRequisitionsAllowedFlag" : false,
  "AccessLevelToOtherAgentsRequisitions" : "None",
  "ManageOrdersAllowedFlag" : false,
  "AccessLevelToOtherAgentsOrders" : "None",
  "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"
  }]
},{
          ...
  }],
"count": 20,
    "hasMore": true,
    "limit": 20,
    "offset": 0,
    "links": [
        {
            "rel": "self",                                  
            "ref":"https://servername/fscmRestApi/resources/version/procurementAgents",
            "name": "procurementAgents",
            "kind": "collection"
        }
    ]
}
Back to Top