Jump to

• Request
• Response

Create scheduling diagnostic attribute

post

/fscmRestApi/resources/11.13.18.05/backlogPlanningOptions/{ConfigurationId}/child/scpSchedulingDiagnosticsAttributes

Request

Path Parameters

• ConfigurationId(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.
• 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

• AttributeId(required): integer (int64)
  Value that uniquely identifies the scheduling diagnostic attribute used in backlog planning options.
• AttributeName(required): string
  Maximum Length: 64

  Scheduling diagnostic attribute used in backlog planning options.
• AttributeOperator: number
  Operator used for the scheduling diagnostics attribute.
• AttributeOperatorValue: string
  Value of the operator used for the scheduling diagnostics attribute (e.g., for number-type attributes: less than or equal to, more than or equal to, is, between).
• AttributeType(required): number
  Attribute based on a date, number, or list of values.
• AttributeValueEnd: string
  Maximum Length: 100

  Ending value when the operator between is selected.
• AttributeValueList: string
  Maximum Length: 255

  Comma-separated values for the selected scheduling diagnostics attributes in backlog planning options.
• AttributeValueStart: string
  Maximum Length: 100

  Starting value when the operator between is selected.
• ConfigurationId(required): integer (int64)
  Configuration ID of the backlog management run, with a value of -1.
• Message: string
  Maximum Length: 255

  A message showing whether the attribute was successfully created or not in the scheduling diagnostics section of backlog planning options.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking, where the number increments every time the row is updated and is compared at the start and end of a transaction to detect if another session has updated the row.
• scpSchedulingDiagnosticsAttrDetails: array Scheduling Diagnostic Attribute Details
  Title: Scheduling Diagnostic Attribute Details

  Attribute values for the attributes specified in scheduling diagnostics.

{
    "required":[
        "AttributeId",
        "AttributeName",
        "AttributeType",
        "ConfigurationId"
    ],
    "type":"object",
    "properties":{
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduling diagnostic attribute used in backlog planning options.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AttributeName":{
            "maxLength":64,
            "type":"string",
            "description":"Scheduling diagnostic attribute used in backlog planning options.",
            "nullable":false
        },
        "AttributeOperator":{
            "type":"number",
            "description":"Operator used for the scheduling diagnostics attribute.",
            "nullable":true
        },
        "AttributeOperatorValue":{
            "type":"string",
            "description":"Value of the operator used for the scheduling diagnostics attribute (e.g., for number-type attributes: less than or equal to, more than or equal to, is, between).",
            "nullable":true
        },
        "AttributeType":{
            "type":"number",
            "description":"Attribute based on a date, number, or list of values.",
            "nullable":false
        },
        "AttributeValueEnd":{
            "maxLength":100,
            "type":"string",
            "description":"Ending value when the operator between is selected.",
            "nullable":true
        },
        "AttributeValueList":{
            "maxLength":255,
            "type":"string",
            "description":"Comma-separated values for the selected scheduling diagnostics attributes in backlog planning options.",
            "nullable":true
        },
        "AttributeValueStart":{
            "maxLength":100,
            "type":"string",
            "description":"Starting value when the operator between is selected.",
            "nullable":true
        },
        "ConfigurationId":{
            "type":"integer",
            "description":"Configuration ID of the backlog management run, with a value of -1.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":10
            }
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"A message showing whether the attribute was successfully created or not in the scheduling diagnostics section of backlog planning options.",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking, where the number increments every time the row is updated and is compared at the start and end of a transaction to detect if another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "scpSchedulingDiagnosticsAttrDetails":{
            "title":"Scheduling Diagnostic Attribute Details",
            "type":"array",
            "description":"Attribute values for the attributes specified in scheduling diagnostics.",
            "items":{
                "$ref":"#/components/schemas/backlogPlanningOptions-scpSchedulingDiagnosticsAttributes-scpSchedulingDiagnosticsAttrDetails-item-post-request"
            }
        }
    }
}

Nested Schema : Scheduling Diagnostic Attribute Details

Type: array

Title: Scheduling Diagnostic Attribute Details

Attribute values for the attributes specified in scheduling diagnostics.

Show Source

• Array of: object backlogPlanningOptions-scpSchedulingDiagnosticsAttributes-scpSchedulingDiagnosticsAttrDetails-item-post-request

{
    "title":"Scheduling Diagnostic Attribute Details",
    "type":"array",
    "description":"Attribute values for the attributes specified in scheduling diagnostics.",
    "items":{
        "$ref":"#/components/schemas/backlogPlanningOptions-scpSchedulingDiagnosticsAttributes-scpSchedulingDiagnosticsAttrDetails-item-post-request"
    }
}

Nested Schema : backlogPlanningOptions-scpSchedulingDiagnosticsAttributes-scpSchedulingDiagnosticsAttrDetails-item-post-request

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 : backlogPlanningOptions-scpSchedulingDiagnosticsAttributes-item-response

Type: object

Show Source

• AttributeId: integer (int64)
  Value that uniquely identifies the scheduling diagnostic attribute used in backlog planning options.
• AttributeName: string
  Maximum Length: 64

  Scheduling diagnostic attribute used in backlog planning options.
• AttributeOperator: number
  Operator used for the scheduling diagnostics attribute.
• AttributeOperatorValue: string
  Value of the operator used for the scheduling diagnostics attribute (e.g., for number-type attributes: less than or equal to, more than or equal to, is, between).
• AttributeType: number
  Attribute based on a date, number, or list of values.
• AttributeValueEnd: string
  Maximum Length: 100

  Ending value when the operator between is selected.
• AttributeValueList: string
  Maximum Length: 255

  Comma-separated values for the selected scheduling diagnostics attributes in backlog planning options.
• AttributeValueStart: string
  Maximum Length: 100

  Starting value when the operator between is selected.
• ConfigurationId: integer (int64)
  Configuration ID of the backlog management run, with a value of -1.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who initially created the attribute in the scheduling diagnostics section of backlog planning options.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the attribute in the scheduling diagnostics section of backlog planning options.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the attribute in the scheduling diagnostics section of backlog planning options.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who most recently updated the attribute in the scheduling diagnostics section of backlog planning options.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login of the user who most recently updated the attribute in the scheduling diagnostics section of backlog planning options.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Maximum Length: 255

  A message showing whether the attribute was successfully created or not in the scheduling diagnostics section of backlog planning options.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking, where the number increments every time the row is updated and is compared at the start and end of a transaction to detect if another session has updated the row.
• scpSchedulingDiagnosticsAttrDetails: array Scheduling Diagnostic Attribute Details
  Title: Scheduling Diagnostic Attribute Details

  Attribute values for the attributes specified in scheduling diagnostics.

{
    "type":"object",
    "properties":{
        "AttributeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the scheduling diagnostic attribute used in backlog planning options.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeName":{
            "maxLength":64,
            "type":"string",
            "description":"Scheduling diagnostic attribute used in backlog planning options.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeOperator":{
            "type":"number",
            "description":"Operator used for the scheduling diagnostics attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeOperatorValue":{
            "type":"string",
            "description":"Value of the operator used for the scheduling diagnostics attribute (e.g., for number-type attributes: less than or equal to, more than or equal to, is, between).",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeType":{
            "type":"number",
            "description":"Attribute based on a date, number, or list of values.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeValueEnd":{
            "maxLength":100,
            "type":"string",
            "description":"Ending value when the operator between is selected.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeValueList":{
            "maxLength":255,
            "type":"string",
            "description":"Comma-separated values for the selected scheduling diagnostics attributes in backlog planning options.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeValueStart":{
            "maxLength":100,
            "type":"string",
            "description":"Starting value when the operator between is selected.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfigurationId":{
            "type":"integer",
            "description":"Configuration ID of the backlog management run, with a value of -1.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who initially created the attribute in the scheduling diagnostics section of backlog planning options.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the attribute in the scheduling diagnostics section of backlog planning options.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the attribute in the scheduling diagnostics section of backlog planning options.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who most recently updated the attribute in the scheduling diagnostics section of backlog planning options.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who most recently updated the attribute in the scheduling diagnostics section of backlog planning options.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Message":{
            "maxLength":255,
            "type":"string",
            "description":"A message showing whether the attribute was successfully created or not in the scheduling diagnostics section of backlog planning options.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking, where the number increments every time the row is updated and is compared at the start and end of a transaction to detect if another session has updated the row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "scpSchedulingDiagnosticsAttrDetails":{
            "title":"Scheduling Diagnostic Attribute Details",
            "type":"array",
            "description":"Attribute values for the attributes specified in scheduling diagnostics.",
            "items":{
                "$ref":"#/components/schemas/backlogPlanningOptions-scpSchedulingDiagnosticsAttributes-scpSchedulingDiagnosticsAttrDetails-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 : Scheduling Diagnostic Attribute Details

Type: array

Title: Scheduling Diagnostic Attribute Details

Attribute values for the attributes specified in scheduling diagnostics.

Show Source

• Array of: object backlogPlanningOptions-scpSchedulingDiagnosticsAttributes-scpSchedulingDiagnosticsAttrDetails-item-response

{
    "title":"Scheduling Diagnostic Attribute Details",
    "type":"array",
    "description":"Attribute values for the attributes specified in scheduling diagnostics.",
    "items":{
        "$ref":"#/components/schemas/backlogPlanningOptions-scpSchedulingDiagnosticsAttributes-scpSchedulingDiagnosticsAttrDetails-item-response"
    }
}

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."
        }
    }
}

Nested Schema : backlogPlanningOptions-scpSchedulingDiagnosticsAttributes-scpSchedulingDiagnosticsAttrDetails-item-response

Type: object

Show Source

• AttributeId: number
  Read Only: true

  Value that uniquely identifies the scheduling diagnostic attribute used in backlog planning options.
• AttributeValue: string
  Read Only: true

  Maximum Length: 255

  Value specified for an attribute in the scheduling diagnostics section of backlog planning options.
• AttributeValueId: number
  Read Only: true

  Value that uniquely identifies the selected attribute's value based on the value identifier in the scheduling diagnostics section of backlog planning options.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Name of the user who initially created the attribute details in the scheduling diagnostics section of backlog planning options.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the attribute details in the scheduling diagnostics section of backlog planning options.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the attribute details in the scheduling diagnostics section of backlog planning options.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who most recently updated the attribute details in the scheduling diagnostics section of backlog planning options.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login of the user who most recently updated the attribute details in the scheduling diagnostics section of backlog planning options.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Used to implement optimistic locking for attribute details, where the number increments every time the row is updated and is compared at the start and end of a transaction to detect if another session has updated the row.
• ValueId: string
  Read Only: true

  Maximum Length: 64

  Value that uniquely identifies the selected attribute's value for attribute details, based on the value identifier in the scheduling diagnostics section of backlog planning options.

{
    "type":"object",
    "properties":{
        "AttributeId":{
            "type":"number",
            "description":"Value that uniquely identifies the scheduling diagnostic attribute used in backlog planning options.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value specified for an attribute in the scheduling diagnostics section of backlog planning options.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValueId":{
            "type":"number",
            "description":"Value that uniquely identifies the selected attribute's value based on the value identifier in the scheduling diagnostics section of backlog planning options.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who initially created the attribute details in the scheduling diagnostics section of backlog planning options.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the attribute details in the scheduling diagnostics section of backlog planning options.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the attribute details in the scheduling diagnostics section of backlog planning options.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who most recently updated the attribute details in the scheduling diagnostics section of backlog planning options.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who most recently updated the attribute details in the scheduling diagnostics section of backlog planning options.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking for attribute details, where the number increments every time the row is updated and is compared at the start and end of a transaction to detect if another session has updated the row.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ValueId":{
            "maxLength":64,
            "type":"string",
            "description":"Value that uniquely identifies the selected attribute's value for attribute details, based on the value identifier in the scheduling diagnostics section of backlog planning options.",
            "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"
    }
}

Links

scpSchedulingDiagnosticsAttrDetails

Operation: /fscmRestApi/resources/11.13.18.05/backlogPlanningOptions/{ConfigurationId}/child/scpSchedulingDiagnosticsAttributes/{AttributeId}/child/scpSchedulingDiagnosticsAttrDetails

Parameters:

• AttributeId: $request.path.AttributeId
• ConfigurationId: $request.path.ConfigurationId

Attribute values for the attributes specified in scheduling diagnostics.

Back to Top