Create planners
post
/fscmRestApi/resources/11.13.18.05/planners
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
Root Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:50
Description of the planner. -
DisableDate: string
(date)
Title:
Disabled Date
Last date that the planner is valid. -
EmailAddress: string
Title:
Email
Maximum Length:240
Email of the employee associated with the planner. -
EmployeeName: string
Title:
Employee Name
Maximum Length:240
Employee name associated with the planner. -
InstanceCode: string
Title:
Source System
Maximum Length:30
Alphanumeric code used to identify the source system. -
PlannerCode: string
Title:
Planner
Maximum Length:10
User name of the planner. -
PlannerId: integer
(int64)
Value that uniquely identifies a planner. This value is generated by the application.
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.
Root Schema : planners-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the planner. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the planner. -
Description: string
Title:
Description
Maximum Length:50
Description of the planner. -
DisableDate: string
(date)
Title:
Disabled Date
Last date that the planner is valid. -
EmailAddress: string
Title:
Email
Maximum Length:240
Email of the employee associated with the planner. -
EmployeeName: string
Title:
Employee Name
Maximum Length:240
Employee name associated with the planner. -
InstanceCode: string
Title:
Source System
Maximum Length:30
Alphanumeric code used to identify the source system. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the planner was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who most recently updated the planner information. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlannerCode: string
Title:
Planner
Maximum Length:10
User name of the planner. -
PlannerId: integer
(int64)
Value that uniquely identifies a planner. This value is generated by the application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.