Jump to

• Request
• Response

Update a person

patch

/fscmRestApi/resources/11.13.18.05/persons/{Personid}

Request

Path Parameters

• Personid(required): integer
  The unique identifier of the person.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{ "type":"object", "properties":{ } }

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

Type: object

Show Source

• Displayname: string
  Read Only: true

  Maximum Length: 240

  The name of the person displayed on the UI.
• Emailaddress: string
  Read Only: true

  Maximum Length: 240

  The primary work email of the person.
• Firstname: string
  Read Only: true

  Maximum Length: 150

  The first name of the person.
• Jobtitle: string
  Read Only: true

  Maximum Length: 240

  The job title of the person.
• Lastname: string
  Read Only: true

  Maximum Length: 150

  The last name of the person.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Orgunitname: string
  Read Only: true

  Maximum Length: 240

  The organization unit name where the person works.
• Personid: integer
  Read Only: true

  The unique identifier of the person.
• Username: string
  Read Only: true

  Maximum Length: 100

  The user name of the person.

{ "type":"object", "properties":{ "Firstname":{ "maxLength":150, "type":"string", "description":"The first name of the person.", "nullable":true, "readOnly":true, "x-queryable":true }, "Jobtitle":{ "maxLength":240, "type":"string", "description":"The job title of the person.", "nullable":true, "readOnly":true, "x-queryable":true }, "Personid":{ "type":"integer", "description":"The unique identifier of the person.", "nullable":true, "readOnly":true, "x-queryable":true }, "Username":{ "maxLength":100, "type":"string", "description":"The user name of the person.", "nullable":true, "readOnly":true, "x-queryable":true }, "Emailaddress":{ "maxLength":240, "type":"string", "description":"The primary work email of the person.", "nullable":true, "readOnly":true, "x-queryable":true }, "Lastname":{ "maxLength":150, "type":"string", "description":"The last name of the person.", "nullable":false, "readOnly":true, "x-queryable":true }, "Displayname":{ "maxLength":240, "type":"string", "description":"The name of the person displayed on the UI.", "nullable":true, "readOnly":true, "x-queryable":true }, "Orgunitname":{ "maxLength":240, "type":"string", "description":"The organization unit name where the person works.", "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" } } } }

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