Update one procurement agent
/fscmRestApi/resources/11.13.18.05/procurementAgents/{AssignmentId}
Request
-
AssignmentId(required): integer(int64)
Value that uniquely identifies the procurement agent assignment.
-
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.
- application/json
object
-
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.
-
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. -
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. -
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.
Response
- application/json
Default Response
-
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.
object
-
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.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to update a procurement agent.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X PATCH -H "Content-Type : application/json" -d 'request payload' "https://servername/fscmRestApi/resources/version/procurementAgents/AssignmentId"
For example, the following command updates the procurement agent where assignment identifier is 20000000000613:
curl -u username:password -X PATCH -H "Content-Type : application/json" -d 'request payload' "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000613"
Example 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 record that it creates. In this example, John Johnson is no longer with the organization and hence the procurement agent is being inactivated.
{ "Agent" : "Johnson, John", "Status": "Inactive", "ManageOrdersAllowedFlag": true, "AccessLevelToOtherAgentsOrders": "Full" }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "AssignmentId" : 20000000000613, "Agent" : "Johnson, John", "AgentId" : 132, "AgentEmail" : "john.johnson@example.com", "ProcurementBU" : "Vision Operations", "ProcurementBUId" : 100000010018224, "Status" : "Inactive", "StatusCode" : "N", "DefaultRequisitioningBU" : null, "DefaultRequisitioningBUId" : null, "DefaultPrinter" : null, "ManageRequisitionsAllowedFlag" : false, "AccessLevelToOtherAgentsRequisitions" : "None", "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/20000000000613", "name" : "procurementAgents", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A6578700000000B77040000000B737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E0002000000027371007E00020000000278" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000613", "name" : "procurementAgents", "kind" : "item" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000613/lov/StatusAccessor", "name" : "StatusAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000613/lov/ActivePersonAccessor", "name" : "ActivePersonAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000613/lov/PrinterAccessor", "name" : "PrinterAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000613/lov/AccessOthersLevelNoModifyActionAccessor", "name" : "AccessOthersLevelNoModifyActionAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000613/lov/AccessOthersLevelAccessor", "name" : "AccessOthersLevelAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000613/lov/ProcurementBUAccessor", "name" : "ProcurementBUAccessor", "kind" : "collection" }, { "rel" : "lov", "href" : "https://servername/fscmRestApi/resources/version/procurementAgents/20000000000613/lov/DefaultReqBuAccessor", "name" : "DefaultReqBuAccessor", "kind" : "collection" } ] }