Jump to

• Request
• Response

Create planners

post

/fscmRestApi/resources/11.13.18.05/planners

Request

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.
• Upsert-Mode: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• EmployeeId: integer (int64)
  Value that uniquely identifies an employee.
• EmployeeName: string
  Title: Employee Name

  Maximum Length: 240

  Employee name associated with the planner.
• EmployeeNumber: string
  Maximum Length: 30

  Unique number that identifies a specific employee.
• 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.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":50,
            "type":"string",
            "description":"Description of the planner.",
            "nullable":true
        },
        "DisableDate":{
            "title":"Disabled Date",
            "type":"string",
            "description":"Last date that the planner is valid.",
            "format":"date",
            "nullable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":240,
            "type":"string",
            "description":"Email of the employee associated with the planner.",
            "nullable":true
        },
        "EmployeeId":{
            "type":"integer",
            "description":"Value that uniquely identifies an employee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EmployeeName":{
            "title":"Employee Name",
            "maxLength":240,
            "type":"string",
            "description":"Employee name associated with the planner.",
            "nullable":true
        },
        "EmployeeNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique number that identifies a specific employee.",
            "nullable":true
        },
        "InstanceCode":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"Alphanumeric code used to identify the source system.",
            "nullable":true
        },
        "PlannerCode":{
            "title":"Planner",
            "maxLength":10,
            "type":"string",
            "description":"User name of the planner.",
            "nullable":true
        },
        "PlannerId":{
            "type":"integer",
            "description":"Value that uniquely identifies a planner. This value is generated by the application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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

Type: object

Show Source

• 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.
• EmployeeId: integer (int64)
  Value that uniquely identifies an employee.
• EmployeeName: string
  Title: Employee Name

  Maximum Length: 240

  Employee name associated with the planner.
• EmployeeNumber: string
  Maximum Length: 30

  Unique number that identifies a specific employee.
• 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the planner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the planner.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":50,
            "type":"string",
            "description":"Description of the planner.",
            "nullable":true,
            "x-queryable":true
        },
        "DisableDate":{
            "title":"Disabled Date",
            "type":"string",
            "description":"Last date that the planner is valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":240,
            "type":"string",
            "description":"Email of the employee associated with the planner.",
            "nullable":true,
            "x-queryable":true
        },
        "EmployeeId":{
            "type":"integer",
            "description":"Value that uniquely identifies an employee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmployeeName":{
            "title":"Employee Name",
            "maxLength":240,
            "type":"string",
            "description":"Employee name associated with the planner.",
            "nullable":true,
            "x-queryable":true
        },
        "EmployeeNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique number that identifies a specific employee.",
            "nullable":true,
            "x-queryable":true
        },
        "InstanceCode":{
            "title":"Source System",
            "maxLength":30,
            "type":"string",
            "description":"Alphanumeric code used to identify the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the planner was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the planner information.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannerCode":{
            "title":"Planner",
            "maxLength":10,
            "type":"string",
            "description":"User name of the planner.",
            "nullable":true,
            "x-queryable":true
        },
        "PlannerId":{
            "type":"integer",
            "description":"Value that uniquely identifies a planner. This value is generated by the application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "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