Jump to

• Request
• Response

Create field service technician subinventories

post

/fscmRestApi/resources/11.13.18.05/technicianSubinventories

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllowPartsOrdersFlag: boolean
  Maximum Length: 1

  Contains one of the following values: null, true, or false. If null or true, then the field service technician can create transfer orders. If false, then the field service technician can't create transfer orders. The default value for this attribute is true.
• DefaultFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then this subinventory is the default subinventory. If false, then this subinventory is not the default. This attribute does not have a default value.
• EnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the subinventory is enabled. If false, then the subinventory is disabled. This attribute does not have a default value.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization.
• OrganizationName: string
  Maximum Length: 240

  Name of the organization.
• PartyId: integer (int64)
  Value that uniquely identifies the technician.
• PartyName: string
  Maximum Length: 360

  Name of the technician.
• StockLocationId: integer (int64)
  Value that uniquely identifies the combination of organization and subinventory.
• StockLocationName: string
  Maximum Length: 29

  Name used for the combination of organization and subinventory.
• Subinventory: string
  Maximum Length: 10

  Value that identifies the subinventory.
• TechSubinventoryId: integer (int64)
  Value that uniquely identifies the technician subinventory.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":false
        },
        "TechSubinventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the technician subinventory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the technician.",
            "nullable":false
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StockLocationName":{
            "maxLength":29,
            "type":"string",
            "description":"Name used for the combination of organization and subinventory.",
            "nullable":true
        },
        "StockLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the combination of organization and subinventory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the technician.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Value that identifies the subinventory.",
            "nullable":false
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then this subinventory is the default subinventory. If false, then this subinventory is not the default. This attribute does not have a default value.",
            "nullable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the subinventory is enabled. If false, then the subinventory is disabled. This attribute does not have a default value.",
            "nullable":true
        },
        "AllowPartsOrdersFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: null, true, or false. If null or true, then the field service technician can create transfer orders. If false, then the field service technician can't create transfer orders. The default value for this attribute is true.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : technicianSubinventories-item-response

Type: object

Show Source

• AllowPartsOrdersFlag: boolean
  Maximum Length: 1

  Contains one of the following values: null, true, or false. If null or true, then the field service technician can create transfer orders. If false, then the field service technician can't create transfer orders. The default value for this attribute is true.
• Condition: string
  Read Only: true

  Maximum Length: 80

  Condition of the subinventory. Valid values are Usable and Defective.
• ConditionCode: string
  Read Only: true

  Maximum Length: 10

  Abbreviation that identifies the condition.
• DefaultFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then this subinventory is the default subinventory. If false, then this subinventory is not the default. This attribute does not have a default value.
• EnabledFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the subinventory is enabled. If false, then the subinventory is disabled. This attribute does not have a default value.
• links: array Links
  Title: Links

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

  Maximum Length: 80

  Type of the subinventory location being assigned to the field service technician. Valid values are Manned, Unmanned, Site Dedicated, and Technician.
• LocationTypeCode: string
  Read Only: true

  Maximum Length: 10

  Abbreviation that identifies the location type.
• OrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the organization.
• OrganizationId: integer (int64)
  Value that uniquely identifies the organization.
• OrganizationName: string
  Maximum Length: 240

  Name of the organization.
• PartyAddress: string
  Read Only: true

  Maximum Length: 4000

  Value that identifies the location of an internal address. This attribute is used to search for technician subinventories having this address.
• PartyId: integer (int64)
  Value that uniquely identifies the technician.
• PartyName: string
  Maximum Length: 360

  Name of the technician.
• PartyNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the technician.
• StockLocationId: integer (int64)
  Value that uniquely identifies the combination of organization and subinventory.
• StockLocationName: string
  Maximum Length: 29

  Name used for the combination of organization and subinventory.
• Subinventory: string
  Maximum Length: 10

  Value that identifies the subinventory.
• TechSubinventoryId: integer (int64)
  Value that uniquely identifies the technician subinventory.

{
    "type":"object",
    "properties":{
        "Condition":{
            "maxLength":80,
            "type":"string",
            "description":"Condition of the subinventory. Valid values are Usable and Defective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the organization.",
            "nullable":false,
            "x-queryable":true
        },
        "TechSubinventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the technician subinventory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "maxLength":360,
            "type":"string",
            "description":"Name of the technician.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyAddress":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that identifies the location of an internal address. This attribute is used to search for technician subinventories having this address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionCode":{
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StockLocationName":{
            "maxLength":29,
            "type":"string",
            "description":"Name used for the combination of organization and subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the technician.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StockLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the combination of organization and subinventory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the technician.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LocationTypeCode":{
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the location type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Value that identifies the subinventory.",
            "nullable":false,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then this subinventory is the default subinventory. If false, then this subinventory is not the default. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the subinventory is enabled. If false, then the subinventory is disabled. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowPartsOrdersFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: null, true, or false. If null or true, then the field service technician can create transfer orders. If false, then the field service technician can't create transfer orders. The default value for this attribute is true.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationType":{
            "maxLength":80,
            "type":"string",
            "description":"Type of the subinventory location being assigned to the field service technician. Valid values are Manned, Unmanned, Site Dedicated, and Technician.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top