Jump to

• Request
• Response
• Examples

Update a collaboration planner

patch

/fscmRestApi/resources/11.13.18.05/collaborationPlanners/{PersonId}

Request

Path Parameters

• PersonId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• dataAccessSecurity: array Data Access Security
  Title: Data Access Security

  The Data Access Security child resource manages data assess security for the collaboration planners.
• FullAccessFlag: boolean
  Title: Full Access

  Contains one of the following values: Yes or No. If Yes, then the collaboration planner has access to the entire order forecast data. If No, then the collaboration planner doesn't have access to the entire order forecast data. The default value is No.
• PersonId: integer (int64)
  Value that uniquely identifies the collaboration planner.
• Status: string
  Value that indicates the administrative status of the collaboration planner. The service provider determines the definitive value for this attribute. For example, active indicates that the collaboration planner can access order forecast data, and inactive indicates that the collaboration planner can't access order forecast data.
• StatusCode: string
  Maximum Length: 30

  Abbreviation that identifies the status of the collaboration planner.
• UserName: string
  Title: User Name

  Maximum Length: 100

  Login that the collaboration planner used to authenticate with the service provider directly. This attribute is required.

{
    "type":"object",
    "properties":{
        "Status":{
            "type":"string",
            "description":"Value that indicates the administrative status of the collaboration planner. The service provider determines the definitive value for this attribute. For example, active indicates that the collaboration planner can access order forecast data, and inactive indicates that the collaboration planner can't access order forecast data.",
            "nullable":true
        },
        "dataAccessSecurity":{
            "title":"Data Access Security",
            "type":"array",
            "description":"The Data Access Security child resource manages data assess security for the collaboration planners.",
            "items":{
                "$ref":"#/components/schemas/collaborationPlanners-dataAccessSecurity-item-patch-request"
            }
        },
        "FullAccessFlag":{
            "title":"Full Access",
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then the collaboration planner has access to the entire order forecast data. If No, then the collaboration planner doesn't have access to the entire order forecast data. The default value is No.",
            "nullable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":100,
            "type":"string",
            "description":"Login that the collaboration planner used to authenticate with the service provider directly. This attribute is required.",
            "nullable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration planner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the collaboration planner.",
            "nullable":true
        }
    }
}

Nested Schema : Data Access Security

Type: array

Title: Data Access Security

The Data Access Security child resource manages data assess security for the collaboration planners.

Show Source

• Array of: object schema

{
    "title":"Data Access Security",
    "type":"array",
    "description":"The Data Access Security child resource manages data assess security for the collaboration planners.",
    "items":{
        "$ref":"#/components/schemas/collaborationPlanners-dataAccessSecurity-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• OrganizationCode: string
  Abbreviation that identifies the organization that receives the item.
• OrganizationId: string
  Title: Organization

  Value that uniquely identifies the organization. This organization receives the shipment. It's a primary key that the application creates when it creates an organization.
• OrganizationName: string
  Title: Organization

  Name of the organization that receives the item.
• ProcurementBUId: integer
  Value that uniquely identifies the procurement business unit. It's a primary key that the application creates when it creates the business unit.
• ProcurementBUName: string
  Title: Procurement BU

  Name of the business unit. The application assigns the supplier site to this business unit.
• SecurityContext: string
  Title: Security Context

  Value that identifies the level of security applied. Values include supplier or supplier site.
• SecurityContextCode: string
  Title: Security Context

  Value that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.
• ShipFromSupplierId: integer
  Title: Ship-from Supplier

  Value that uniquely identifies the supplier who ships the item. It's a primary key that the application creates when it creates the supplier.
• ShipFromSupplierName: string
  Title: Ship-from Supplier

  Name of the supplier that ships the item.
• ShipFromSupplierSiteId: integer
  Title: Ship-from Supplier Site

  Value that uniquely identifies the supplier site who ships the item. It's a primary key that the application creates when it creates the supplier site.
• ShipFromSupplierSiteName: string
  Title: Ship-from Supplier Site

  Name of the supplier site that ships the item.
• SourceSystem: string
  Title: Source System

  Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.
• SourceSystemCode: string
  Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.

{
    "type":"object",
    "properties":{
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit. It's a primary key that the application creates when it creates the business unit.",
            "nullable":true
        },
        "OrganizationName":{
            "title":"Organization",
            "type":"string",
            "description":"Name of the organization that receives the item.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"string",
            "description":"Value that uniquely identifies the organization. This organization receives the shipment. It's a primary key that the application creates when it creates an organization.",
            "nullable":true
        },
        "ShipFromSupplierSiteId":{
            "title":"Ship-from Supplier Site",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site who ships the item. It's a primary key that the application creates when it creates the supplier site.",
            "nullable":true
        },
        "ShipFromSupplierId":{
            "title":"Ship-from Supplier",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who ships the item. It's a primary key that the application creates when it creates the supplier.",
            "nullable":true
        },
        "ShipFromSupplierSiteName":{
            "title":"Ship-from Supplier Site",
            "type":"string",
            "description":"Name of the supplier site that ships the item.",
            "nullable":true
        },
        "SecurityContextCode":{
            "title":"Security Context",
            "type":"string",
            "description":"Value that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.",
            "nullable":true
        },
        "SecurityContext":{
            "title":"Security Context",
            "type":"string",
            "description":"Value that identifies the level of security applied. Values include supplier or supplier site.",
            "nullable":true
        },
        "ShipFromSupplierName":{
            "title":"Ship-from Supplier",
            "type":"string",
            "description":"Name of the supplier that ships the item.",
            "nullable":true
        },
        "ProcurementBUName":{
            "title":"Procurement BU",
            "type":"string",
            "description":"Name of the business unit. The application assigns the supplier site to this business unit.",
            "nullable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization that receives the item.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemCode":{
            "type":"string",
            "description":"Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystem":{
            "title":"Source System",
            "type":"string",
            "description":"Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the collaboration planner.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the collaboration planner.
• dataAccessSecurity: array Data Access Security
  Title: Data Access Security

  The Data Access Security child resource manages data assess security for the collaboration planners.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Display name of the collaboration planner. This is usually the full name.
• Email: string
  Title: Email

  Read Only: true

  Maximum Length: 240

  Email address of the collaboration planner. The service provider uses the canonical form of the email address; for example, [e-mail].
• FirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150

  First name of the collaboration planner.
• FullAccessFlag: boolean
  Title: Full Access

  Contains one of the following values: Yes or No. If Yes, then the collaboration planner has access to the entire order forecast data. If No, then the collaboration planner doesn't have access to the entire order forecast data. The default value is No.
• LastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150

  Last name of the collaboration planner.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the collaboration planner.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the collaboration planner.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer (int64)
  Value that uniquely identifies the collaboration planner.
• Status: string
  Value that indicates the administrative status of the collaboration planner. The service provider determines the definitive value for this attribute. For example, active indicates that the collaboration planner can access order forecast data, and inactive indicates that the collaboration planner can't access order forecast data.
• StatusCode: string
  Maximum Length: 30

  Abbreviation that identifies the status of the collaboration planner.
• UserName: string
  Title: User Name

  Maximum Length: 100

  Login that the collaboration planner used to authenticate with the service provider directly. This attribute is required.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the collaboration planner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Value that indicates the administrative status of the collaboration planner. The service provider determines the definitive value for this attribute. For example, active indicates that the collaboration planner can access order forecast data, and inactive indicates that the collaboration planner can't access order forecast data.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the collaboration planner.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Email":{
            "title":"Email",
            "maxLength":240,
            "type":"string",
            "description":"Email address of the collaboration planner. The service provider uses the canonical form of the email address; for example, [e-mail].",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the collaboration planner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UserName":{
            "title":"User Name",
            "maxLength":100,
            "type":"string",
            "description":"Login that the collaboration planner used to authenticate with the service provider directly. This attribute is required.",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"First name of the collaboration planner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "dataAccessSecurity":{
            "title":"Data Access Security",
            "type":"array",
            "description":"The Data Access Security child resource manages data assess security for the collaboration planners.",
            "items":{
                "$ref":"#/components/schemas/collaborationPlanners-dataAccessSecurity-item-response"
            }
        },
        "StatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the status of the collaboration planner.",
            "nullable":true,
            "x-queryable":true
        },
        "FullAccessFlag":{
            "title":"Full Access",
            "type":"boolean",
            "description":"Contains one of the following values: Yes or No. If Yes, then the collaboration planner has access to the entire order forecast data. If No, then the collaboration planner doesn't have access to the entire order forecast data. The default value is No.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the collaboration planner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Display name of the collaboration planner. This is usually the full name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"Last name of the collaboration planner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the collaboration planner.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Data Access Security

Type: array

Title: Data Access Security

The Data Access Security child resource manages data assess security for the collaboration planners.

Show Source

• Array of: object collaborationPlanners-dataAccessSecurity-item-response

{
    "title":"Data Access Security",
    "type":"array",
    "description":"The Data Access Security child resource manages data assess security for the collaboration planners.",
    "items":{
        "$ref":"#/components/schemas/collaborationPlanners-dataAccessSecurity-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : collaborationPlanners-dataAccessSecurity-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the data access security.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the data access security.
• DataAccessId: integer (int64)
  Read Only: true

  Value that uniquely identifies the data access security of the collaboration planner.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the data access security.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the data access security.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Abbreviation that identifies the organization that receives the item.
• OrganizationId: string
  Title: Organization

  Value that uniquely identifies the organization. This organization receives the shipment. It's a primary key that the application creates when it creates an organization.
• OrganizationName: string
  Title: Organization

  Name of the organization that receives the item.
• ProcurementBUId: integer
  Value that uniquely identifies the procurement business unit. It's a primary key that the application creates when it creates the business unit.
• ProcurementBUName: string
  Title: Procurement BU

  Name of the business unit. The application assigns the supplier site to this business unit.
• SecurityContext: string
  Title: Security Context

  Value that identifies the level of security applied. Values include supplier or supplier site.
• SecurityContextCode: string
  Title: Security Context

  Value that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.
• ShipFromSupplierId: integer
  Title: Ship-from Supplier

  Value that uniquely identifies the supplier who ships the item. It's a primary key that the application creates when it creates the supplier.
• ShipFromSupplierName: string
  Title: Ship-from Supplier

  Name of the supplier that ships the item.
• ShipFromSupplierSiteId: integer
  Title: Ship-from Supplier Site

  Value that uniquely identifies the supplier site who ships the item. It's a primary key that the application creates when it creates the supplier site.
• ShipFromSupplierSiteName: string
  Title: Ship-from Supplier Site

  Name of the supplier site that ships the item.
• SourceSystem: string
  Title: Source System

  Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.
• SourceSystemCode: string
  Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the data access security.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit. It's a primary key that the application creates when it creates the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization",
            "type":"string",
            "description":"Name of the organization that receives the item.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the data access security.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the data access security.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"string",
            "description":"Value that uniquely identifies the organization. This organization receives the shipment. It's a primary key that the application creates when it creates an organization.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipFromSupplierSiteId":{
            "title":"Ship-from Supplier Site",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site who ships the item. It's a primary key that the application creates when it creates the supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipFromSupplierId":{
            "title":"Ship-from Supplier",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who ships the item. It's a primary key that the application creates when it creates the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipFromSupplierSiteName":{
            "title":"Ship-from Supplier Site",
            "type":"string",
            "description":"Name of the supplier site that ships the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SecurityContextCode":{
            "title":"Security Context",
            "type":"string",
            "description":"Value that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.",
            "nullable":true,
            "x-queryable":true
        },
        "SecurityContext":{
            "title":"Security Context",
            "type":"string",
            "description":"Value that identifies the level of security applied. Values include supplier or supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipFromSupplierName":{
            "title":"Ship-from Supplier",
            "type":"string",
            "description":"Name of the supplier that ships the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBUName":{
            "title":"Procurement BU",
            "type":"string",
            "description":"Name of the business unit. The application assigns the supplier site to this business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization that receives the item.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceSystemCode":{
            "type":"string",
            "description":"Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystem":{
            "title":"Source System",
            "type":"string",
            "description":"Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.",
            "nullable":true,
            "x-queryable":false
        },
        "DataAccessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the data access security of the collaboration planner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the data access security.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : 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."
        }
    }
}

Links

dataAccessSecurity

Operation: /fscmRestApi/resources/11.13.18.05/collaborationPlanners/{PersonId}/child/dataAccessSecurity

Parameters:

• PersonId: $request.path.PersonId

The Data Access Security child resource manages data assess security for the collaboration planners.

Back to Top

Examples

This example describes how to update a collaboration planner.

Example cURL Command

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

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

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 updates.

{
"Status": "Inactive",
}

Example Response Body

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

        {
            "PersonId": 3927,
            "UserName": "SmithJohn",
            "FirstName": "John",
            "LastName": "Smith",
            "DisplayName": "Smith,John",
            "Email": "[e-mail]",
            "StatusCode": "I",
            "Status": "Inactive",
            "CreatedBy": "AdminUser",
            "CreationDate": "2018-06-12T01:44:21.126+00:00",
            "LastUpdatedBy": "AdminUser",
            "LastUpdateDate": "2018-06-12T01:45:22.917+00:00",
            "FullAccessFlag": "false",
        }

Back to Top